From 0c2567408647c40ca2de5949f62943962b84db1d Mon Sep 17 00:00:00 2001
From: ZeYi Lin <944270057@qq.com>
Date: Thu, 1 Aug 2024 16:31:58 +0800
Subject: [PATCH] update swanlab.init api
---
zh/api/py-init.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/zh/api/py-init.md b/zh/api/py-init.md
index 59a73c4..bf898e0 100644
--- a/zh/api/py-init.md
+++ b/zh/api/py-init.md
@@ -11,6 +11,7 @@ init(
suffix: str = "default",
mode: str = "cloud",
load: str = None,
+ public: bool = None,
**kwargs,
)
```
@@ -26,6 +27,7 @@ init(
| suffix | (str, None, bool) experiment_name的后缀。完整的实验名称由`experiment_name`和`suffix`共同构成。
默认值为"default",代表默认的后缀规则为`'%b%d-%h-%m-%s'`,例如:`Feb03_14-45-37`。
设置为`None`或`False`将不加后缀。
|
| mode | (str) 设置swanlab实验创建的模式,可选"cloud"、"local"、"disabled",默认设置为"cloud"。
`cloud`:将实验上传到云端。
`local`:不上传到云端,但会记录实验到本地。
`disabled`:不上传也不记录。|
| load | (str) 加载的配置文件路径,支持yaml和json文件。|
+| public | (bool) 设置使用代码直接创建SwanLab项目的可见性,默认为False即私有。|
## 介绍