Skip to content

Commit

Permalink
fix: zh
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeyi-Lin committed Jan 16, 2025
1 parent b43affe commit 46e5d08
Show file tree
Hide file tree
Showing 21 changed files with 69 additions and 69 deletions.
4 changes: 2 additions & 2 deletions en/examples/pretrain_llm.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Inference results are as follows:
Ensure the swanlab version is 0.3.19
:::

Pretraining LLMs requires significant GPU compute power and memory. This article recommends using [SwanLab Launch](/zh/api/cli-swanlab-remote-gpu) to leverage cloud GPUs for pretraining.
Pretraining LLMs requires significant GPU compute power and memory. This article recommends using [SwanLab Launch](/en/api/cli-swanlab-remote-gpu) to leverage cloud GPUs for pretraining.

First, upload the dataset using the `swanlab upload -n WIKI_CN WIKI_CN` command:

Expand All @@ -366,7 +366,7 @@ You can also use `swanlab task list` to view the uploaded dataset ID:

![show_id](/assets/examples/pretrain_llm/show_id.png)

Refer to the [SwanLab Launch official documentation](/zh/api/cli-swanlab-remote-gpu) to create a `swanlab.yaml` file locally and enter the following information:
Refer to the [SwanLab Launch official documentation](/en/api/cli-swanlab-remote-gpu) to create a `swanlab.yaml` file locally and enter the following information:

```yaml
apiVersion: swanlab/v1
Expand Down
6 changes: 3 additions & 3 deletions en/guide_cloud/experiment_track/log-media.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ for i in range(3):
swanlab.log({"examples": image_list})
```

For more details about images, refer to the [API Documentation](/zh/api/py-Image).
For more details about images, refer to the [API Documentation](/en/api/py-Image).

## 2. Audio

[API Documentation](/zh/api/py-Audio)
[API Documentation](/en/api/py-Audio)

![](/assets/media-audio-1.jpg)

Expand Down Expand Up @@ -112,7 +112,7 @@ run.log({"examples": examples})

## 3. Text

[API Documentation](/zh/api/py-Text)
[API Documentation](/en/api/py-Text)

### 3.1 Log Strings

Expand Down
2 changes: 1 addition & 1 deletion en/guide_cloud/experiment_track/set-experiment-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ swanlab.config.set["batch_size", 32]

### Set with Configuration Files

You can initialize `config` using json and yaml configuration files. For details, please refer to [Create Experiment with Configuration File](/zh/guide_cloud/experiment_track/create-experiment-by-configfile).
You can initialize `config` using json and yaml configuration files. For details, please refer to [Create Experiment with Configuration File](/en/guide_cloud/experiment_track/create-experiment-by-configfile).
12 changes: 6 additions & 6 deletions en/guide_cloud/experiment_track/what-is-experiment-track.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ swanlab.log({"loss": loss})

Explore the following resources to learn about SwanLab experiment tracking:

- Read the [Quick Start](/zh/guide_cloud/general/quick-start)
- Read the [Quick Start](/en/guide_cloud/general/quick-start)
- Explore this chapter to learn how to:
- [Create an Experiment](/zh/guide_cloud/experiment_track/create-experiment)
- [Configure an Experiment](/zh/guide_cloud/experiment_track/set-experiment-config.md)
- [Log Metrics](/zh/guide_cloud/experiment_track/log-experiment-metric.md)
- [View Experiment Results](/zh/guide_cloud/experiment_track/view-result.md)
- Explore the SwanLab Python library in the [API Documentation](/zh/api/api-index).
- [Create an Experiment](/en/guide_cloud/experiment_track/create-experiment)
- [Configure an Experiment](/en/guide_cloud/experiment_track/set-experiment-config.md)
- [Log Metrics](/en/guide_cloud/experiment_track/log-experiment-metric.md)
- [View Experiment Results](/en/guide_cloud/experiment_track/view-result.md)
- Explore the SwanLab Python library in the [API Documentation](/en/api/api-index).
28 changes: 14 additions & 14 deletions en/guide_cloud/general/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ by Cunyue

**🚀New Features**
- 🎉Benchmark Community Beta version is now live: https://swanlab.cn/benchmarks
- Added integration with PaddleYolo, [Documentation](/zh/guide_cloud/integration/integration-paddleyolo.md)
- Added integration with PaddleYolo, [Documentation](/en/guide_cloud/integration/integration-paddleyolo.md)

**Bug Fixes**
- Fixed sqlite parallel read/write errors during multiple parallel experiment submissions, [#715](https://github.com/SwanHubX/SwanLab/issues/715)
Expand All @@ -87,13 +87,13 @@ by Cunyue
## v0.3.21 - 2024.9.26

**🚀New Features**
- [Organization creation](/zh/guide_cloud/general/organization.md) is now fully open, with a limit of 15 people per organization
- [Organization creation](/en/guide_cloud/general/organization.md) is now fully open, with a limit of 15 people per organization
- Experiment names now support "duplicates" with a new experiment naming system

## v0.3.19 - 2024.9.2

**🚀New Features**
- (Beta) Added cloud storage functionality for task-based training `swanlab task`, [Documentation](/zh/api/cli-swanlab-remote-gpu.html)
- (Beta) Added cloud storage functionality for task-based training `swanlab task`, [Documentation](/en/api/cli-swanlab-remote-gpu.html)

**Improvements**
- [Environment] Added CPU brand recording
Expand All @@ -113,7 +113,7 @@ by Cunyue

**🚀New Features**
- (Beta) Added task-based training `swanlab task` functionality
- Added integration with `torchtune`, [Documentation](/zh/guide_cloud/integration/integration-pytorch-torchtune)
- Added integration with `torchtune`, [Documentation](/en/guide_cloud/integration/integration-pytorch-torchtune)

**Improvements**
- Added `public` parameter to `swanlab.init` to set new project visibility, defaults to `False`
Expand Down Expand Up @@ -169,7 +169,7 @@ by Cunyue
- `swanlab logout`: Support logging out of SwanLab account in terminal

**👥Integration**
- Added integration with HuggingFace Accelerate, [Documentation](/zh/guide_cloud/integration/integration-huggingface-accelerate.md)
- Added integration with HuggingFace Accelerate, [Documentation](/en/guide_cloud/integration/integration-huggingface-accelerate.md)

**⚡️Improvements**
- Improved media file upload stability
Expand Down Expand Up @@ -205,19 +205,19 @@ by Cunyue
- Optimized ultralytics integration code

**👥Integration**
- Integration with Stable Baseline3, [Guide](/zh/guide_cloud/integration/integration-sb3.md)
- Integration with Stable Baseline3, [Guide](/en/guide_cloud/integration/integration-sb3.md)

## v0.3.3 - 2024.5.22

**👥Integration**
- Integration with Weights & Biases, supporting wandb project conversion to `SwanLab` projects, [Guide](/zh/guide_cloud/integration/integration-wandb.md)
- Integration with Ultralytics, [Guide](/zh/guide_cloud/integration/integration-ultralytics.md)
- Integration with fastai, [Guide](/zh/guide_cloud/integration/integration-fastai.md)
- Integration with Weights & Biases, supporting wandb project conversion to `SwanLab` projects, [Guide](/en/guide_cloud/integration/integration-wandb.md)
- Integration with Ultralytics, [Guide](/en/guide_cloud/integration/integration-ultralytics.md)
- Integration with fastai, [Guide](/en/guide_cloud/integration/integration-fastai.md)

## v0.3.2 - 2024.5.17

**👥Integration**
- Integration with Tensorboard, supporting conversion of `Tensorboard` log files to `SwanLab` experiments, [Guide](/zh/guide_cloud/integration/integration-tensorboard.md)
- Integration with Tensorboard, supporting conversion of `Tensorboard` log files to `SwanLab` experiments, [Guide](/en/guide_cloud/integration/integration-tensorboard.md)

**🚀New Features**
- Support for downloading line charts as PNG images
Expand All @@ -243,15 +243,15 @@ by Cunyue
## v0.3.0 Cloud Version Launch! - 2024.5.1

**🚀New Features**
- Released [Cloud Version](https://dev101.swanlab.cn)
- Released [Cloud Version](https://swanlab.cn)
- `swanlab.init` supports initialization with config files
- "Environment" now records Apple M series chips

**👥Integration**
- Integration with 🤗HuggingFace Transformers, [Guide](/zh/guide_cloud/integration/integration-huggingface-transformers.md)
- Integration with PyTorch Lightning, [Guide](/zh/guide_cloud/integration/integration-pytorch-lightning.md)
- Integration with 🤗HuggingFace Transformers, [Guide](/en/guide_cloud/integration/integration-huggingface-transformers.md)
- Integration with PyTorch Lightning, [Guide](/en/guide_cloud/integration/integration-pytorch-lightning.md)
- Integration with Jupyter Notebook
- Integration with Hydra, [Guide](/zh/guide_cloud/integration/integration-hydra.md)
- Integration with Hydra, [Guide](/en/guide_cloud/integration/integration-hydra.md)

**⚡️Improvements**
- Optimized line chart rendering for large datasets
Expand Down
2 changes: 1 addition & 1 deletion en/guide_cloud/general/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,4 @@ Run the code, visit [SwanLab](https://swanlab.cn), and see the improvement of th
After logging in to the SwanLab website, the API Key will be displayed on the [user settings](https://swanlab.cn/settings) page.

### 2. Can I use SwanLab offline?
Yes, please refer to the [self-hosting](/zh/guide_cloud/self_host/offline-board.md) section for the specific process.
Yes, please refer to the [self-hosting](/en/guide_cloud/self_host/offline-board.md) section for the specific process.
4 changes: 2 additions & 2 deletions en/guide_cloud/integration/integration-pytorch.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ You can use PyTorch to train deep learning models while using SwanLab for experi

::: warning Integration with Other PyTorch Ecosystems

- [Lightning](/zh/guide_cloud/integration/integration-pytorch-lightning.md)
- [Torchtune](/zh/guide_cloud/integration/integration-pytorch-torchtune.md)
- [Lightning](/en/guide_cloud/integration/integration-pytorch-lightning.md)
- [Torchtune](/en/guide_cloud/integration/integration-pytorch-torchtune.md)

:::

Expand Down
2 changes: 1 addition & 1 deletion en/guide_cloud/integration/integration-xtuner.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ visualizer = dict(
)])
```

For other integration methods with the MM series and more flexible configurations, please refer to [MMEngine Integration with SwanLab](https://docs.swanlab.cn/zh/guide_cloud/integration/integration-mmengine.html).
For other integration methods with the MM series and more flexible configurations, please refer to [MMEngine Integration with SwanLab](https://docs.swanlab.cn/en/guide_cloud/integration/integration-mmengine.html).
2 changes: 1 addition & 1 deletion en/guide_cloud/self_host/offline-board.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ After running, a backend service will be started, and SwanLab will provide you w

Access this link to view experiments in the browser using the offline dashboard.

[How to Set IP and Port Number](/zh/api/cli-swanlab-watch.md#设置ip和端口号)
[How to Set IP and Port Number](/en/api/cli-swanlab-watch.md)
4 changes: 2 additions & 2 deletions zh/api/cli-swanlab-convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ swanlab convert [OPTIONS]

### Tensorboard

[集成-Tensorboard](/zh/guide_cloud/integration/integration-tensorboard.md)
[集成-Tensorboard](/guide_cloud/integration/integration-tensorboard.md)

### Weights & Biases

[集成-Weights & Biases](/zh/guide_cloud/integration/integration-wandb.md)
[集成-Weights & Biases](/guide_cloud/integration/integration-wandb.md)
4 changes: 2 additions & 2 deletions zh/api/py-converter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

将其他日志工具的内容转换为SwanLab项目的API。

- [swanlab.converter.TFBConverter](/zh/guide_cloud/integration/integration-tensorboard#方式二-代码内转换)
- [swanlab.converter.WandbConverter](/zh/guide_cloud/integration/integration-wandb#方式二-代码内转换)
- [swanlab.converter.TFBConverter](/guide_cloud/integration/integration-tensorboard)
- [swanlab.converter.WandbConverter](/guide_cloud/integration/integration-wandb)
22 changes: 11 additions & 11 deletions zh/api/py-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

SwanLab与外部项目的集成API。

- [swanlab.integration.pytorch_lightning](/zh/guide_cloud/integration/integration-pytorch-lightning.md)
- [swanlab.integration.huggingface](/zh/guide_cloud/integration/integration-huggingface-transformers.md)
- [swanlab.integration.accelerate](/zh/guide_cloud/integration/integration-huggingface-accelerate.md)
- [swanlab.integration.ultralytics](/zh/guide_cloud/integration/integration-ultralytics.md)
- [swanlab.integration.fastai](/zh/guide_cloud/integration/integration-fastai.md)
- [swanlab.integration.openai](/zh/guide_cloud/integration/integration-openai.md)
- [swanlab.integration.zhipuai](/zh/guide_cloud/integration/integration-zhipuai.md)
- [swanlab.integration.sb3](/zh/guide_cloud/integration/integration-sb3.md)
- [swanlab.integration.keras](/zh/guide_cloud/integration/integration-keras.md)
- [swanlab.integration.mmengine](/zh/guide_cloud/integration/integration-mmengine.md)
- [swanlab.integration.torchtune](/zh/guide_cloud/integration/integration-pytorch-torchtune.md)
- [swanlab.integration.pytorch_lightning](/guide_cloud/integration/integration-pytorch-lightning.md)
- [swanlab.integration.huggingface](/guide_cloud/integration/integration-huggingface-transformers.md)
- [swanlab.integration.accelerate](/guide_cloud/integration/integration-huggingface-accelerate.md)
- [swanlab.integration.ultralytics](/guide_cloud/integration/integration-ultralytics.md)
- [swanlab.integration.fastai](/guide_cloud/integration/integration-fastai.md)
- [swanlab.integration.openai](/guide_cloud/integration/integration-openai.md)
- [swanlab.integration.zhipuai](/guide_cloud/integration/integration-zhipuai.md)
- [swanlab.integration.sb3](/guide_cloud/integration/integration-sb3.md)
- [swanlab.integration.keras](/guide_cloud/integration/integration-keras.md)
- [swanlab.integration.mmengine](/guide_cloud/integration/integration-mmengine.md)
- [swanlab.integration.torchtune](/guide_cloud/integration/integration-pytorch-torchtune.md)
6 changes: 3 additions & 3 deletions zh/api/py-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ swanlab.log({"acc": 0.9, "loss":0.1462})

## 更多用法

- 记录[图像](/zh/api/py-Image.md)
- 记录[音频](/zh/api/py-Audio.md)
- 记录[文本](/zh/api/py-Text.md)
- 记录[图像](/api/py-Image.md)
- 记录[音频](/api/py-Audio.md)
- 记录[文本](/api/py-Text.md)
2 changes: 1 addition & 1 deletion zh/examples/fashionmnist.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ if __name__ == "__main__":
)
```

- `config`是如何发挥作用的? 👉 [设置实验配置](/zh/guide_cloud/experiment_track/set-experiment-config)
- `config`是如何发挥作用的? 👉 [设置实验配置](/guide_cloud/experiment_track/set-experiment-config)

## 效果演示

Expand Down
6 changes: 3 additions & 3 deletions zh/examples/pretrain_llm.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ print("GENERATE:", pipe("人工智能", num_return_sequences=1)[0]["generated_te
确保swanlab版本为0.3.19
:::

预训练LLM对于GPU的算力和显存要求非常高,本文推荐使用[SwanLab Launch](/zh/api/cli-swanlab-remote-gpu)利用云上GPU进行预训练。
预训练LLM对于GPU的算力和显存要求非常高,本文推荐使用[SwanLab Launch](/api/cli-swanlab-remote-gpu)利用云上GPU进行预训练。

首先使用`swanlab upload -n WIKI_CN WIKI_CN`命令上传数据集

Expand All @@ -373,7 +373,7 @@ print("GENERATE:", pipe("人工智能", num_return_sequences=1)[0]["generated_te

![show_id](/assets/examples/pretrain_llm/show_id.png)

参考[SwanLab Launch官方文档](/zh/api/cli-swanlab-remote-gpu),本地创建`swanlab.yaml`文件并写入如下信息
参考[SwanLab Launch官方文档](/api/cli-swanlab-remote-gpu),本地创建`swanlab.yaml`文件并写入如下信息

```yaml
apiVersion: swanlab/v1
Expand Down Expand Up @@ -405,7 +405,7 @@ swanlab launch -f swanlab.yaml

![remote_devices](/assets/examples/pretrain_llm/remote_devices.png)

关于如何查看、终止远程实验,可参考[SwanLab Launch官方文档](/zh/api/cli-swanlab-remote-gpu)
关于如何查看、终止远程实验,可参考[SwanLab Launch官方文档](/api/cli-swanlab-remote-gpu)

## 参考链接

Expand Down
6 changes: 3 additions & 3 deletions zh/guide_cloud/experiment_track/create-experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ run = swanlab.init(
swanlab.config={"epochs": 20, "learning_rate": 1e-4, "batch_size": 32, "model_type": "CNN"}
```

有关如何配置实验的更多信息,请参阅[设置实验配置](/zh/guide_cloud/experiment_track/set-experiment-config.md)
有关如何配置实验的更多信息,请参阅[设置实验配置](/guide_cloud/experiment_track/set-experiment-config.md)

<br>

Expand Down Expand Up @@ -114,7 +114,7 @@ for epoch in range(swanlab.config.epochs):

使用SwanLab仪表盘作为管理和可视化人工智能模型结果的一站式节点。
可以可视化丰富的交互式图表,例如折线图、图像图表、音频图表等。
有关如何查看实验更多信息,请参阅[查看实验结果](/zh/guide_cloud/experiment_track/view-result.md)
有关如何查看实验更多信息,请参阅[查看实验结果](/guide_cloud/experiment_track/view-result.md)

![](/assets/example-mnist.jpg)

Expand Down Expand Up @@ -144,4 +144,4 @@ swanlab.init(
)
```

关于创建SwanLab实验时更多可用参数的信息,请参阅API文档中的[swanlab.init](/zh/api/py-init.md)文档。
关于创建SwanLab实验时更多可用参数的信息,请参阅API文档中的[swanlab.init](/api/py-init.md)文档。
2 changes: 1 addition & 1 deletion zh/guide_cloud/experiment_track/log-experiment-metric.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ for epoch in range(num_epochs):

`swanlab.log` 记录时,会根据指标名,将`{指标名: 指标}`字典汇总到一个统一位置存储。

⚠️需要注意的是,`swanlab.log({key: value})`中的value必须是`int` / `float` / `BaseType`这三种类型(如果传入的是`str`类型,会先尝试转为`float`,如果转换失败就会报错),其中`BaseType`类型主要是多媒体数据,详情请看[记录多媒体数据](/zh/guide_cloud/experiment_track/log-media.md)
⚠️需要注意的是,`swanlab.log({key: value})`中的value必须是`int` / `float` / `BaseType`这三种类型(如果传入的是`str`类型,会先尝试转为`float`,如果转换失败就会报错),其中`BaseType`类型主要是多媒体数据,详情请看[记录多媒体数据](/guide_cloud/experiment_track/log-media.md)

在每次记录时,会为该次记录赋予一个 `step`。在默认情况下,`step` 为0开始,并在你每一次在同一个指标名下记录时,`step` 等于该指标名历史记录的最大 `step` + 1,例如:

Expand Down
8 changes: 4 additions & 4 deletions zh/guide_cloud/experiment_track/log-media.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ SwanLab 支持记录媒体数据(图像、音频、文本等)以直观地探

## 1.图像

`swanlab.Image` 支持记录多种图像类型,包括 numpy、PIL、Tensor、读取文件等。[API文档](/zh/api/py-Image)
`swanlab.Image` 支持记录多种图像类型,包括 numpy、PIL、Tensor、读取文件等。[API文档](/api/py-Image)

![](/assets/media-image-1.jpg)

Expand Down Expand Up @@ -76,11 +76,11 @@ for i in range(3):
swanlab.log({"examples": image_list})
```

关于图像的更多细节,可参考[API文档](/zh/api/py-Image)
关于图像的更多细节,可参考[API文档](/api/py-Image)

## 2. 音频

[API文档](/zh/api/py-Audio)
[API文档](/api/py-Audio)

![](/assets/media-audio-1.jpg)

Expand Down Expand Up @@ -112,7 +112,7 @@ run.log({"examples": examples})

## 3. 文本

[API文档](/zh/api/py-Text)
[API文档](/api/py-Text)

### 3.1 记录字符串

Expand Down
2 changes: 1 addition & 1 deletion zh/guide_cloud/experiment_track/set-experiment-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ swanlab.config.set["batch_size", 32]

### 用配置文件设置

可以用json和yaml配置文件初始化 `config`,详情请查看[用配置文件创建实验](/zh/guide_cloud/experiment_track/create-experiment-by-configfile)
可以用json和yaml配置文件初始化 `config`,详情请查看[用配置文件创建实验](/guide_cloud/experiment_track/create-experiment-by-configfile)
12 changes: 6 additions & 6 deletions zh/guide_cloud/experiment_track/what-is-experiment-track.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ swanlab.log({"loss": loss})

探索以下资源以了解SwanLab实验跟踪:

- 阅读[快速开始](/zh/guide_cloud/general/quick-start)
- 阅读[快速开始](/guide_cloud/general/quick-start)
- 探索本章以了解如何:
- [创建一个实验](/zh/guide_cloud/experiment_track/create-experiment)
- [配置实验](/zh/guide_cloud/experiment_track/set-experiment-config.md)
- [记录指标](/zh/guide_cloud/experiment_track/log-experiment-metric.md)
- [查看实验结果](/zh/guide_cloud/experiment_track/view-result.md)
-[API文档](/zh/api/api-index)中探索SwanLab Python 库。
- [创建一个实验](/guide_cloud/experiment_track/create-experiment)
- [配置实验](/guide_cloud/experiment_track/set-experiment-config.md)
- [记录指标](/guide_cloud/experiment_track/log-experiment-metric.md)
- [查看实验结果](/guide_cloud/experiment_track/view-result.md)
-[API文档](/api/api-index)中探索SwanLab Python 库。
2 changes: 1 addition & 1 deletion zh/guide_cloud/general/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ by Cunyue

**🚀新增功能**
- 🎉基线社区Beta版本已上线:https://swanlab.cn/benchmarks
- 新增与PaddleYolo的集成,[文档](/zh/guide_cloud/integration/integration-paddleyolo.md)
- 新增与PaddleYolo的集成,[文档](/guide_cloud/integration/integration-paddleyolo.md)

**修复问题**
- 修复了在多组并行实验提交时,出现sqlite并行读写报错的问题,[#715](https://github.com/SwanHubX/SwanLab/issues/715)
Expand Down

0 comments on commit 46e5d08

Please sign in to comment.