SwanLab官方文档

Appearance

🚀快速开始 ​

安装 SwanLab 并在几分钟内开始跟踪你的人工智能实验。

quick-start-1

1. 安装SwanLab ​

使用 pip 在Python3环境的计算机上安装swanlab库。

打开命令行，输入：

bash
pip install swanlab

按下回车，等待片刻完成安装。

如果遇到安装速度慢的问题，可以指定清华源安装：
pip install swanlab -i https://pypi.tuna.tsinghua.edu.cn/simple

2. 登录账号 ​

如果你还没有SwanLab账号，请在 官网 免费注册。

打开命令行，输入：

bash
swanlab login

当你看到如下提示时：

bash
swanlab: Logging into swanlab cloud.
swanlab: You can find your API key at: https://swanlab.cn/settings
swanlab: Paste an API key from your profile and hit enter, or press 'CTRL-C' to quit:

在用户设置页面复制您的 API Key，粘贴后按下回车，即可完成登录。之后无需再次登录。

如果你的计算机不太支持swanlab login的登录方式，也可以使用python脚本登录：
import swanlab
swanlab.login(api_key="你的API Key")

3. 开启一个实验并跟踪超参数 ​

在Python脚本中，我们用swanlab.init创建一个SwanLab实验，并向config参数传递将一个包含超参数键值对的字典：

python
import swanlab

run = swanlab.init(
    # 设置项目
    project="my-project",
    # 跟踪超参数与实验元数据
    config={
        "learning_rate": 0.01,
        "epochs": 10,
    },
)

run是SwanLab的基本组成部分，你将经常使用它来记录与跟踪实验指标。

4. 记录实验指标 ​

在Python脚本中，用swanlab.log记录实验指标（比如准确率acc和损失值loss）。

用法是将一个包含指标的字典传递给swanlab.log：

python
swanlab.log({"accuracy": acc, "loss": loss})

5. 完整代码，在线查看可视化看板 ​

我们将上面的步骤整合为下面所示的完整代码：

python
import swanlab
import random

# 初始化SwanLab
run = swanlab.init(
    # 设置项目
    project="my-project",
    # 跟踪超参数与实验元数据
    config={
        "learning_rate": 0.01,
        "epochs": 10,
    },
)

print(f"学习率为{run.config.learning_rate}")

offset = random.random() / 5

# 模拟训练过程
for epoch in range(2, run.config.epochs):
    acc = 1 - 2**-epoch - random.random() / epoch - offset
    loss = 2**-epoch + random.random() / epoch + offset
    print(f"epoch={epoch}, accuracy={acc}, loss={loss}")
    # 记录指标
    swanlab.log({"accuracy": acc, "loss": loss})

运行代码，访问SwanLab，查看在每个训练步骤中，你使用SwanLab记录的指标（准确率和损失值）的改进情况。

quick-start-1

下一步是什么 ​

  1. 查看SwanLab如何记录多媒体内容（图片、音频、文本、...）
  2. 查看SwanLab记录MNIST手写体识别的案例
  3. 查看与其他框架的集成
  4. 查看如何通过SwanLab与团队协作

常见问题 ​

1. 在哪里可以找到我的API Key？ ​

登陆SwanLab网站后，API Key将显示在用户设置页面上。

2. 我可以离线使用SwanLab吗？ ​

可以，具体流程请查看自托管部分。