lamindb.curators.Curator

class lamindb.curators.Curator(dataset, schema=None)

Bases: object

Dataset curator.

A Curator object makes it easy to validate, standardize & annotate datasets.

Added in version 1.1.0.

See:

Methods

save_artifact(*, key=None, description=None, revises=None, run=None)

Save an annotated artifact.

Parameters:
  • key (str | None, default: None) – A path-like key to reference artifact in default storage, e.g., "myfolder/myfile.fcs". Artifacts with the same key form a version family.

  • description (str | None, default: None) – A description.

  • revises (Artifact | None, default: None) – Previous version of the artifact. Is an alternative way to passing key to trigger a new version.

  • run (Run | None, default: None) – The run that creates the artifact.

Return type:

Artifact

Returns:

A saved artifact record.

validate()

Validate dataset.

Raises:

lamindb.errors.ValidationError – If validation fails.

Return type:

bool | str