lamindb.core.BaseCurator

class lamindb.core.BaseCurator

Bases: object

Curate a dataset.

Methods

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

Save the dataset as artifact.

Parameters:

• description (str | None, default: None) – A description of the DataFrame object.

• 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 revision family.

• revises (Artifact | None, default: None) – Previous version of the artifact. Triggers a revision.

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

Return type:

Artifact

Returns:

A saved artifact record.

standardize(key)

Replace synonyms with standardized values.

Inplace modification of the dataset.

Parameters:

key (str) – The name of the column to standardize.

Return type:

None

Returns:

None

validate()

Validate dataset.

This method also registers the validated records in the current instance.

Return type:

bool

Returns:

Boolean indicating whether the dataset is validated.