Skip to content

Commit

Permalink
update swanlab.init api
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeyi-Lin committed Aug 1, 2024
1 parent da09817 commit 0c25674
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions zh/api/py-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ init(
suffix: str = "default",
mode: str = "cloud",
load: str = None,
public: bool = None,
**kwargs,
)
```
Expand All @@ -26,6 +27,7 @@ init(
| suffix | (str, None, bool) experiment_name的后缀。完整的实验名称由`experiment_name``suffix`共同构成。<br> 默认值为"default",代表默认的后缀规则为`'%b%d-%h-%m-%s'`,例如:`Feb03_14-45-37`。<br>设置为`None``False`将不加后缀。<br>|
| mode | (str) 设置swanlab实验创建的模式,可选"cloud"、"local"、"disabled",默认设置为"cloud"。<br>`cloud`:将实验上传到云端。<br>`local`:不上传到云端,但会记录实验到本地。<br>`disabled`:不上传也不记录。|
| load | (str) 加载的配置文件路径,支持yaml和json文件。|
| public | (bool) 设置使用代码直接创建SwanLab项目的可见性,默认为False即私有。|

## 介绍

Expand Down

0 comments on commit 0c25674

Please sign in to comment.