PythonResultTracker

class PythonResultTracker(store_metrics=True)[source]

Bases: ResultTracker

A tracker which stores everything in Python dictionaries.

Example Usage: get default configuration

from pykeen.pipeline import pipeline
from pykeen.trackers import PythonResultTracker

tracker = PythonResultTracker()
result = pipeline(
    dataset="nations",
    model="PairRE",
    result_tracker=tracker,
)
print("Default configuration:")
for k, v in tracker.configuration.items():
    print(f"{k:20} = {v}")

Initialize the tracker.

Methods Summary

log_metrics(metrics[, step, prefix])

Log metrics to result store.

log_params(params[, prefix])

Log parameters to result store.

start_run([run_name])

Start a run with an optional name.

Methods Documentation

Parameters:

store_metrics (bool) –

log_metrics(metrics, step=None, prefix=None)[source]

Log metrics to result store.

Parameters:
  • metrics (Mapping[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)[source]

Log parameters to result store.

Return type:

None

Parameters:
start_run(run_name=None)[source]

Start a run with an optional name.

Return type:

None

Parameters:

run_name (str | None) –