lamindb

A data framework for biology.

Data lineage

Track inputs, outputs & environment of a notebook or script run.

track([transform, project, space, params, ...])	Track a run of your notebook or script.
finish([ignore_non_consecutive])	Finish the run and write a run report.

Decorate a function with @tracked() to track inputs, outputs & environment of function executions.

tracked([uid])

Track function runs.

Registries

Manage artifacts and transforms.

Artifact()	Datasets & models stored as files, folders, or arrays.
Storage()	Storage locations of artifacts such as S3 buckets or local directories.
Transform()	Data transformations such as scripts, notebooks, functions, or pipelines.
Run()	Runs of transforms such as the execution of a script.

Validate and annotate artifacts.

ULabel()	Universal labels.
Feature()	Dataset dimensions.
Param()	Parameters of runs & models.
Schema()	Schemas of a dataset such as the set of columns of a DataFrame.

Manage projects.

User()	Users.
Collection()	Collections of artifacts.
Project()	Projects.
Space()	Spaces to restrict access to records to specific users or teams.
Reference()	References such as internal studies, papers, documents, or URLs.
Person()	People such as authors of a study or collaborators in a project.

Other

Functions and classes.

connect([instance])	Connect to an instance.
view([df, limit, modules, registries])	View metadata.
save(records[, ignore_conflicts])	Bulk save records.
UPath(*args[, protocol])	Paths: low-level key-value access to files/objects.
settings	Global live settings (Settings).
context	Global run context (Context).

Curators and integrations.

curators	Curators.
integrations	Integrations.

Low-level functionality.

examples	Examples.
curators	Curators.
integrations	Integrations.
errors	Errors.
setup	Setup & configure LaminDB.
base	Base library.
core	Core library.
models	Models library.