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 的 Logger (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 扫描很有用。

• online (Optional[bool]) – 如果为 True，数据将记录到 Comet 服务器，否则将本地存储在离线实验中。默认为 True。

• experiment_name (Optional[str]) – 实验名称。如果未提供，Comet 将自动生成名称。

• tags (Optional[List[str]]) – 与实验关联的标签。

• log_code (bool) – 是否记录源代码。默认为 True。

• **kwargs (Dict[str, Any]) – 传递给 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()

Raises:

ImportError – 如果未安装 comet_ml 包。

注意

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

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

记录配置

参数:

config (DictConfig) – 要记录的配置

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

记录多个标量值。

参数:

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

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