swanhubx / swanlab-docs

SwanLab Official Documentation | SwanLab官方文档

swanlab-docs

本仓库托管了SwanLab的官方文档，基于vitepress。

如何为文档做贡献

很简单！只需要增添或修改Markdown文件，提交他们，创建一个PR就可以。

本地开发流程

1. 克隆本仓库

git clone https://github.com/SwanHubX/SwanLab-Docs

2. 安装环境

npm add -D vitepress

3. 本地开发，在项目根目录运行：

npm run docs:dev

4. 打包与预览

npm run docs:build
npm run docs:preview

swanlab-docs's Issues

更新API-convert

[Docs] 将watch的`-l`都改成新版

增加Issue模版

第一版文档TODO LIST

• 查看实验结果
• 集成-PyTorch
• 集成-OpenAI
• 补齐图片素材
• 案例-猫狗分类
• 案例-MNIST-补文案
• 案例-FashionMNIST
• 案例-Hello World模拟实验

[Integration] 优化MMEngine集成内容

更新日志-v0.3.3

[Example] YOLO目标检测

🚀 Content

Ultralytics YOLO目标检测的案例。

[Integration] 更新对于Transformers的集成文档——增加eval callback的构建案例指引

class LLMSwanLabCallback(SwanLabCallback):    
    def on_epoch_end(self, args, state, control, **kwargs):
        test_text_list = []
        for index, row in test_df.iterrows():
            instruction = row['instruction']
            input_value = row['input']
            
            messages = [
                {"role": "system", "content": f"{instruction}"},
                {"role": "user", "content": f"{input_value}"}
            ]

            response = predict(messages, model, tokenizer)
            messages.append({"role": "assistant", "content": f"{response}"})
            result_text = f"{messages[0]}\n\n{messages[1]}\n\n{messages[2]}"
            test_text_list.append(swanlab.Text(result_text, caption=response))
            
        swanlab.log({"Prediction": test_text_list}, step=state.global_step)

🚑 Any additional [like screenshots]

• SwanLab Version: v0.3.10

[Docs] 关于配置域名白名单

[API] swanlab.init 增加参数 mode

增加案例-PyTorch BERT

swanlab仓库的README也同步一下

v0.3.2 文档更新

• #3
• v0.3.2 更新日志
• 集成-Tensorboard
• 案例-MNIST代码优化
• API-swanlab.Audio修改
• 论文中引用-增加doi

[Docs] 更新贡献者

[Docs] 更新“记录多媒体数据”

🚀 Content

1. 让行文可读性更强
2. 博客：SwanLab如何记录多媒体数据
3. 早期的博客附上对应的Link

[Example] LSTM时间序列预测

• 机器学习股价预测

[Docs] 更新多媒体图表部分-caption的含义以及图示例

🚀 Content

🚑 Any additional [like screenshots]

• SwanLab Version:

• Platform:

[Example] 人像分割

🚀 Content

🚑 Any additional [like screenshots]

• SwanLab Version:

• Platform:

集成-代码增加行高亮

Bug：改一下「实验跟踪」的API

https://docs.swanlab.cn/zh/guide_cloud/experiment_track/what-is-experiment-track.html

[Docs] 增加与swift框架的集成

和swift框架的集成方法和与HuggingFace Transformers一样

[Example] StableDiffusion系列

[Integration] 集成-torchtune

增加0.3.15中的torchtune集成指引

[Example] sb3-强化学习案例

优化集成-hydra的内容

[Integration] accelerate库

🚀 Content

添加关于swanlab与accelerate库的集成文档。

添加方式：

1. npm run docs:dev开启文档开发模式
2. 在/.vitepress/config.mts下的如下部分添加一行HuggingFace Accelerate，这里的作用是在官方文档的侧边栏增加一个链接；其中text代表标题，link则是文档markdown的名称

  {
    text: '⚡️ 集成',
    // collapsed: false,
    items: [
      { text: 'Argparse', link:'integration/integration-argparse' },
      ...
      { text: 'HuggingFace Accelerate', link:'integration/integration-huggingface-accelerate'}
      ...
      { text: 'ZhipuAI', link: 'integration/integration-zhipuai'},
    ]
  },

3. 在zh/guide_cloud/integration下创建一个integration-huggingface-accelerate.md，然后参考其他文档格式写Markdown即可

🚑 Any additional [like screenshots]

• SwanLab Version: v0.3.9

[Example] ResNet植物识别

[Docs] 更新“什么是实验跟踪”

🚀 Content

改进内容：

1. 更加准确、详细地阐述实验跟踪的概念
2. 实验跟踪的好处、与做训练的价值

JupyterNotebook部分-增加finish内容

[Docs] FAQ增加如何局部看图表细节

[Docs] 增加ultralytics ddp模式下的内容

增加一些框架图

增加：集成-Weights & Biases

增加集成-StableBaseline-3

请问下，离线看板怎么切换成中文版的呢？

对于`swanlab.log`的value类型需要为float/init的attention

写在：https://docs.swanlab.cn/zh/guide_cloud/experiment_track/log-experiment-metric.html

增加集成-fastai

修改集成Tensorboard部分

• 增加对于参数的解释
• 修改例子