Trackio documentation

快速入门指南

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

快速入门指南

Open In Colab

要开始使用,您可以运行一个简单的示例,该示例会记录一些虚假的训练指标:

import trackio
import random
import time

runs = 3
epochs = 8


for run in range(runs):
    trackio.init(
        project="my-project",
        config={"epochs": epochs, "learning_rate": 0.001, "batch_size": 64}
    )

    for epoch in range(epochs):
        train_loss = random.uniform(0.2, 1.0)
        train_acc = random.uniform(0.6, 0.95)

        val_loss = train_loss - random.uniform(0.01, 0.1)
        val_acc = train_acc + random.uniform(0.01, 0.05)

        trackio.log({
            "epoch": epoch,
            "train_loss": train_loss,
            "train_accuracy": train_acc,
            "val_loss": val_loss,
            "val_accuracy": val_acc
        })

        time.sleep(0.2)

trackio.finish()

运行上述命令后,终端将打印启动仪表板的说明。

在大多数情况下,trackio 的用法与 wandb 完全相同,因此您可以轻松地在两者之间切换。

import trackio as wandb

仪表板

您可以通过运行以下命令启动仪表板:

Shell
Python
trackio show

您还可以提供一个可选的 project 名称作为参数,以直接加载特定项目:

Shell
Python
trackio show --project "my-project"

部署到 Hugging Face Spaces

调用 trackio.init() 时,默认情况下服务将在本地运行,并将项目数据存储在本机上。

但如果你向 init() 传递一个 space_id,例如:

trackio.init(project="my-project", space_id="orgname/space_id")

或

trackio.init(project="my-project", space_id="username/space_id")

它将根据需要使用现有的 Hugging Face Space 或自动部署一个新的 Hugging Face Space。您应在本地使用 huggingface-cli 登录,并且您的令牌应具有创建 Space 所需的写入权限。

或者,您可以通过运行以下命令将现有的本地项目同步到 Hugging Face Space:

Shell
Python
trackio sync --project "my-project" --space-id "username/space_id"

如果该 Space 尚不存在,此操作将创建它,并将所有运行记录及相关数据上传至该 Space。您也可以使用 sdk="static" 同步到一个轻量级的静态 Space,或者使用 freeze 为实时 Space 创建一个只读快照。冻结的 Space 是某一时间点的快照,除非再次执行冻结操作,否则不会获取原始 Gradio Space 后续产生的指标。有关更多详细信息,请参阅 部署和嵌入仪表板 页面。

Update on GitHub