lamindb.base.types

Base types.

Central object types

lamindb.base.types.ArtifactKind

alias of Literal[‘dataset’, ‘model’, ‘plan’, ‘__lamindb_run__’, ‘__lamindb_config__’]

lamindb.base.types.TransformKind

alias of Literal[‘pipeline’, ‘notebook’, ‘script’, ‘function’]

lamindb.base.types.BlockKind

Block kind, a README.md-type page or comment.

Any block expects Markdown as the formatting language.

lamindb.base.types.BranchStatus

Branch status.

status	code	description
closed	-2	Change Request was closed without merging.
merged	-1	The branch was merged into another branch.
standalone	0	A standalone branch without Change Request.
draft	1	Change Request exists but is not ready for review.
review	2	Change Request is ready for review.

The database stores the branch status as an integer code in field _status_code.

lamindb.base.types.RunStatus

Run status.

status	code	description
scheduled	-3	The run is scheduled.
restarted	-2	The run was restarted.
started	-1	The run has started.
completed	0	The run completed successfully.
errored	1	The run ended with an error.
aborted	2	The run was aborted.

The database stores the run status as an integer code in field _status_code.

lamindb.base.types.SimpleDtype

Python types for simple scalar dtypes.

This alias represents the preferred constructor inputs for simple feature dtypes (int, float, str, bool, datetime.date, datetime.datetime, dict).

lamindb.base.types.SimpleDtypeStr

String-serialized representations of simple data types.

lamindb.base.types.SimpleDvalue

Values corresponding to SimpleDtype.

lamindb.base.types.DtypeStr

alias of Literal[‘num’, ‘int’, ‘float’, ‘str’, ‘bool’, ‘datetime’, ‘datetime64[ns, UTC]’, ‘date’, ‘dict’, ‘path’, ‘url’, ‘object’]

Basic types

lamindb.base.types.AnyPathStr

alias of str | Path | UPath

lamindb.base.types.StrField

alias of str | DeferredAttribute

lamindb.base.types.ListLike

alias of list[str] | pd.Series | ndarray

lamindb.base.types.FieldAttr

alias of DeferredAttribute