lamindb.track

lamindb.track(uid=None, *, params=None, new_run=None, path=None, transform=None)

Initiate a run with tracked data lineage.

  • sets transform & run by creating or loading Transform & Run records

  • saves compute environment as a requirements.txt file: run.environment

If sync_git_repo is set, checks whether a script-like transform exists in a git repository and links it.

Parameters:
  • uid (str | None, default: None) – A uid to create or load a transform.

  • params (dict | None, default: None) – A dictionary of parameters to track for the run.

  • new_run (bool | None, default: None) – If False, loads latest run of transform (default notebook), if True, creates new run (default pipeline).

  • path (str | None, default: None) – Filepath of notebook or script. Only needed if it can’t be automatically detected.

  • transform (Transform | None, default: None) – Useful to track an abstract pipeline.

Return type:

None

Examples

To track the run of a notebook or script, call:

>>> import lamindb as ln
>>> ln.track()