Neptune结果跟踪器

class NeptuneResultTracker(project_qualified_name: str | None = None, api_token: str | None = None, offline: bool = False, experiment_id: int | None = None, experiment_name: str | None = None, tags: Collection[str] | None = None)[源代码]

基础类：ResultTracker

Neptune.ai 的跟踪器。

初始化Neptune结果跟踪器。

Parameters:

  • project_qualified_name (str | None) – 项目的限定名称，格式为 namespace/project_name。 如果为 None，将使用 NEPTUNE_PROJECT 环境变量的值。用于测试时， 应为 /sandbox

  • api_token (str | None) –

    用户的API令牌。如果为None，将使用NEPTUNE_API_TOKEN环境变量的值。

    注意

    强烈建议使用NEPTUNE_API_TOKEN环境变量，而不是将API令牌以明文形式放在源代码中。

  • 离线 (bool) – 在离线模式下运行neptune（使用neptune.OfflineBackend作为后端）

  • experiment_id (int | None) – 要使用的现有实验的标识符。如果未提供，将依赖于 experiment_name。

  • experiment_name (str | None) – 实验的名称。如果没有提供experiment_id，将根据名称创建一个。

  • 标签 (Collection[str] | None) – 要添加到实验中的标签集合

Raises:

ValueError – 如果既没有提供实验名称也没有提供实验ID

方法总结

log_metrics(metrics[, step, prefix])

将指标记录到结果存储中。

log_params(params[, prefix])

将日志参数记录到结果存储中。

方法文档

log_metrics(metrics: Mapping[str, float], step: int | None = None, prefix: str | None = None) → None[source]

将指标记录到结果存储中。

Parameters:

  • metrics (Mapping[str, float]) – 要记录的指标。

  • step (int | None) – 一个可选的步骤，用于附加指标（例如，epoch）。

  • prefix (str | None) – 一个可选的前缀，用于在指标中的每个键前添加。

Return type:

无

log_params(params: Mapping[str, Any], prefix: str | None = None) → None[来源]

将日志参数记录到结果存储中。

Parameters:
Return type:

无