NeptuneResultTracker

class NeptuneResultTracker(project_qualified_name=None, api_token=None, offline=False, experiment_id=None, experiment_name=None, tags=None)

Bases: pykeen.trackers.base.ResultTracker

A tracker for Neptune.ai.

Initialize the Neptune result tracker.

Parameters

• project_qualified_name (Optional[str]) – Qualified name of a project in a form of namespace/project_name. If None, the value of NEPTUNE_PROJECT environment variable will be taken. For testing, should be <your username>/sandbox

• api_token (Optional[str]) –

  User’s API token. If None, the value of NEPTUNE_API_TOKEN environment variable will be taken.

  Note

  It is strongly recommended to use NEPTUNE_API_TOKEN environment variable rather than placing your API token in plain text in your source code.

• offline (bool) – Run neptune in offline mode (uses neptune.OfflineBackend as the backend)

• experiment_id (Optional[int]) – The identifier of a pre-existing experiment to use. If not given, will rely on the experiment_name.

• experiment_name (Optional[str]) – The name of the experiment. If no experiment_id is given, one will be created based on the name.

• tags (Optional[Collection[str]]) – A collection of tags to add to the experiment

Methods Summary

log_metrics(metrics[, step, prefix])	Log metrics to result store.
log_params(params[, prefix])	Log parameters to result store.

Methods Documentation

log_metrics(metrics, step=None, prefix=None)

Log metrics to result store.

Parameters

• metrics (Dict[str, float]) – The metrics to log.

• step (Optional[int]) – An optional step to attach the metrics to (e.g. the epoch).

• prefix (Optional[str]) – An optional prefix to prepend to every key in metrics.

Return type

None

log_params(params, prefix=None)

Log parameters to result store.

Return type

None