使用 W&B 更快速地构建更优秀的模型。跟踪并可视化机器学习流水线中的各个环节，从数据集到生产环境中的机器学习模型。立即开始使用 W&B，请 注册 W&B 账户！

正在构建 LLM 应用？借助我们的 GenAI 新工具套件 Weave，您可以跟踪、调试、评估和监控 LLM 应用。

 

文档

请参阅 W&B 开发者指南 和 API 参考指南，以获取 W&B 平台的完整技术说明。

 

快速入门

安装 W&B，即可跟踪、可视化并管理任何规模的机器学习实验。

安装 wandb 库

pip install wandb

注册并创建 API 密钥

注册一个 W&B 账户。在 wandb.ai/settings 创建一个新的 API 密钥，并将其安全保存。您也可以选择使用 wandb login CLI 在本地配置您的 API 密钥。不过，这一步并非必须——首次使用时，W&B 会提示您创建 API 密钥。

注意： API 密钥仅在创建时可见一次。请将您的 API 密钥存储在密码管理器或环境变量等安全位置。

创建一个机器学习训练实验

在您的 Python 脚本或笔记本中，使用 wandb.init() 初始化一个 W&B 运行。指定超参数，并将指标及其他信息记录到 W&B。

import wandb

# 运行将被记录到的项目
project = "my-awesome-project"

# 包含超参数的字典
config = {"epochs": 1337, "lr": 3e-4}

# 使用 `with` 语法可在退出代码块时自动标记运行结束；若发生异常，则标记为“失败”。
#
# 在笔记本中，您也可以直接写 `run = wandb.init()`，然后手动调用 `run.finish()`，而不必使用 `with` 块。
with wandb.init(project=project, config=config) as run:
    # 训练代码在此处

    # 使用 run.log() 将数值记录到 W&B
    run.log({"accuracy": 0.9, "loss": 0.1})

访问 wandb.ai/home，查看已记录的指标，如准确率和损失，以及它们在每个训练步骤中的变化情况。每个运行对象都会以自动生成的名称显示在“运行”列中。

 

集成

W&B 集成了流行的机器学习框架和库，使您能够快速轻松地在现有项目中设置实验跟踪和数据版本控制。

对于希望将 W&B 添加到新框架的开发者，请参考 W&B 开发者指南。

 

W&B 托管选项

Weights & Biases 提供云端服务，也可部署在您的私有基础设施上。您可以通过以下三种方式在生产环境中搭建 W&B 服务器：

1. 多租户云：完全托管的平台，部署在 W&B 的 Google Cloud Platform (GCP) 账户中，位于 GCP 的北美地区。
2. 专用云：单租户、完全托管的平台，部署在 W&B 的 AWS、GCP 或 Azure 云账户中。每个专用云实例都拥有独立的网络、计算和存储资源，与其他 W&B 专用云实例隔离。
3. 自托管：将 W&B 服务器部署在您的 AWS、GCP 或 Azure 云账户中，或在您的本地基础设施内。

更多详细信息，请参阅 W&B 开发者指南中的 托管文档。

 

Python 版本支持

我们承诺，在 Python 软件基金会规定的官方生命周期结束（EOL）日期之后，至少继续支持我们的最低要求 Python 版本六个月。Python EOL 日期列表可在此处找到：这里。

当我们停止对某个 Python 版本的支持时，我们会增加库的小版本号以反映这一变化。

 

贡献指南

Weights & Biases 热爱开源，欢迎社区贡献！有关开发流程和 wandb 库内部结构的更多信息，请参阅 贡献指南。如需报告 wandb 的 bug 或提出功能请求，请访问 GitHub Issues 或联系 support@wandb.com。

 

W&B 社区

加入不断壮大的 W&B 社区，并通过我们的 Discord 与 W&B 团队互动。关注 W&B Fully Connected 获取最新的 AI 动态和教程。

 

许可证

MIT 许可证

Weights & Biases (wandb) 快速上手指南

Weights & Biases (W&B) 是一款强大的机器学习实验跟踪与可视化工具，帮助开发者更快地构建更优模型。从数据集管理到生产级模型监控，W&B 能完整记录机器学习流水线的各个环节。

环境准备

• 操作系统：支持 Linux、macOS 和 Windows
• Python 版本：支持 Python 3.7 及以上版本（官方承诺在 Python 版本正式停止维护后至少继续支持 6 个月）
• 前置依赖：无需特殊系统依赖，仅需标准的 Python 环境
• 网络要求：需要能够访问 api.wandb.ai（国内用户若遇连接问题，可考虑配置代理或使用海外云服务器）

安装步骤

使用 pip 安装 wandb 库：

pip install wandb

提示：国内用户如遇下载速度慢，可使用清华或阿里云镜像源加速安装：

pip install wandb -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

1. 登录与配置 API Key

首次使用前，需注册 W&B 账号并获取 API Key：

1. 访问 wandb.ai 注册账号
2. 登录后进入 设置页面 创建新的 API Key
3. 重要：API Key 仅在创建时显示一次，请妥善保存（建议使用密码管理器或环境变量存储）

在终端执行以下命令配置本地 API Key（可选，也可在首次运行时按提示输入）：

wandb login

2. 开始记录实验

在你的 Python 脚本或 Jupyter Notebook 中，只需几行代码即可开始跟踪实验：

import wandb

# 项目名称
project = "my-awesome-project"

# 超参数配置
config = {"epochs": 1337, "lr": 3e-4}

# 初始化运行记录
# 使用 with 语句可自动标记运行结束；若发生异常则标记为"failed"
# 在 Notebook 中也可使用 run = wandb.init() 并手动调用 run.finish()
with wandb.init(project=project, config=config) as run:
    # 在此处编写你的训练代码
    
    # 记录指标数据
    run.log({"accuracy": 0.9, "loss": 0.1})

3. 查看结果

代码运行后，访问 wandb.ai/home 即可查看实时更新的实验仪表盘。你可以：

• 可视化准确率（accuracy）、损失（loss）等指标随训练步数的变化趋势
• 对比不同超参数配置下的实验结果
• 查看每次运行自动生成的唯一名称和详细日志

---

现在你已成功迈出使用 W&B 的第一步！后续可探索其与 PyTorch、TensorFlow、Keras 等主流框架的深度集成，或利用 Weave 工具链进行大语言模型（LLM）应用的调试与评估。