CometLogger

class torchtune.training.metric_logging.CometLogger(api_key: Optional[str] = None, workspace: Optional[str] = None, project: Optional[str] = None, experiment_key: Optional[str] = None, mode: Optional[str] = None, online: Optional[bool] = None, experiment_name: Optional[str] = None, tags: Optional[List[str]] = None, log_code: bool = True, **kwargs: Dict[str, Any])

用于 Comet (https://www.comet.com/site/) 的记录器。Comet 是一种实验跟踪工具，可帮助 ML 团队跟踪、调试、比较和重现其模型训练运行。

有关 Comet 期望的参数的更多信息，请参见 https://www.comet.com/docs/v2/guides/experiment-management/configure-sdk/#for-the-experiment.

参数：

• api_key (Optional[str]) – Comet API 密钥。建议使用 comet login 配置 API 密钥。

• workspace (Optional[str]) – Comet 工作区名称。如果未提供，则使用默认工作区。

• project (Optional[str]) – Comet 项目名称。默认为未分类。

• experiment_key (Optional[str]) – 用于记录的 Comet 实验的密钥。这用于将数据追加到现有实验或控制新实验的 ID（例如匹配另一个 ID）。必须是长度在 32 到 50 个字符之间的字母数字字符串。

• mode (Optional[str]) –

  控制 Comet 实验的启动方式。

  • "get_or_create": 如果需要，启动一个新的实验，或将记录持久化到现有实验。

  • "get": 继续将记录到由 experiment_key 值标识的现有实验。

  • "create": 始终创建一个新实验，这对于 HPO 扫描很有用。

• 在线 (可选[布尔值]) – 如果为 True，则数据将记录到 Comet 服务器，否则将存储在离线实验中的本地位置。默认值为 True。

• 实验名称 (可选[字符串]) – 实验的名称。如果未提供，Comet 将自动生成一个名称。

• 标签 (可选[列表[字符串]]) – 与实验相关的标签。

• 记录代码 (布尔值) – 是否记录源代码。默认为 True。

• **kwargs (字典[字符串, 任何]) – 传递给 comet_ml.start 的附加参数。请参阅 https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/Experiment-Creation/#comet_ml.ExperimentConfig

示例

>>> from torchtune.training.metric_logging import CometLogger
>>> logger = CometLogger(project_name="my_project", workspace="my_workspace")
>>> logger.log("my_metric", 1.0, 1)
>>> logger.log_dict({"my_metric": 1.0}, 1)
>>> logger.close()

引发:

导入错误 – 如果 comet_ml 包未安装。

注意

此记录器需要安装 comet_ml 包。您可以使用 pip install comet_ml 安装它。您需要在使用此记录器之前设置您的 Comet.ml API 密钥。您可以通过在终端中调用 comet login 来完成此操作。您也可以将其设置为 COMET_API_KEY 环境变量。

close() → 无

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

log(name: 字符串, data: 联合[张量, ndarray, 整数, 浮点数], step: 整数) → 无

记录标量数据。

参数：

• name (字符串) – 用于分组标量的标签名称

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

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

log_config(config: DictConfig) → 无

记录配置

参数：

config (DictConfig) – 要记录的配置

log_dict(payload: 映射[字符串, 联合[张量, ndarray, 整数, 浮点数]], step: 整数) → 无

记录多个标量值。

参数：

• payload (映射[字符串, 标量]) – 标签名称和标量值的字典

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