WandBLogger

class torchtune.training.metric_logging.WandBLogger(project: str = 'torchtune', entity: Optional[str] = None, group: Optional[str] = None, log_dir: Optional[str] = None, **kwargs)

用于 Weights and Biases 应用程序 (https://wandb.ai/) 的日志记录器。有关 WandB 期望的参数的更多信息，请参阅 https://docs.wandb.ai/ref/python/init。

参数：

• project (str) – WandB 项目名称。默认为 torchtune。

• entity (Optional[str]) – WandB 实体名称。如果您未指定实体，则运行将发送到您的默认实体，通常是您的用户名。

• group (Optional[str]) – WandB 组名称，用于将运行分组在一起。如果您未指定组，则运行将记录为单独的实验。

• log_dir (Optional[str]) – WandB 日志目录。如果未指定，则使用 kwargs 中提供的 dir 参数。否则，使用根目录。

• **kwargs – 传递给 wandb.init 的其他参数

示例

>>> from torchtune.training.metric_logging import WandBLogger
>>> logger = WandBLogger(project="my_project", entity="my_entity", group="my_group")
>>> logger.log("my_metric", 1.0, 1)
>>> logger.log_dict({"my_metric": 1.0}, 1)
>>> logger.close()

引发：

ImportError – 如果未安装 wandb 包。

注意

此日志记录器需要安装 wandb 包。您可以使用 pip install wandb 安装它。为了使用日志记录器，您需要登录到您的 WandB 帐户。您可以在终端中运行 wandb login 来执行此操作。

close() → None

关闭日志资源，必要时刷新。在调用 close 后不应写入日志。

log(name: str, data: Union[Tensor, ndarray, int, float], step: int) → None

记录标量数据。

参数：

• name (str) – 用于对标量进行分组的标签名称

• data (Scalar) – 要记录的标量数据

• step (int) – 要记录的步骤值

log_config(config: DictConfig) → None

将配置保存在本地，并将其记录到 W&B。配置存储在与检查点相同的目录中。您可以在以下链接中查看记录到 W&B 的配置示例：https://wandb.ai/capecape/torchtune/runs/6053ofw0/files/torchtune_config_j67sb73v.yaml

参数：

config (DictConfig) – 要记录的配置

log_dict(payload: Mapping[str, Union[Tensor, ndarray, int, float]], step: int) → None

记录多个标量值。

参数：

• payload (Mapping[str, Scalar]) – 标签名称和标量值的字典

• step (int) – 要记录的步骤值