lamindb.base.types .md

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.DtypeStr

String-serialized representations of common data types.

description

lamindb

pandas

numerical

"num"

int | float

integer

"int"

int64 | int32 | int16 | int8 | uint | ...

float

"float"

float64 | float32 | float16 | float8 | ...

string

"str"

object

boolean

"bool"

boolean | bool

datetime

"datetime"

datetime

date

"date"

object (pandera requires an ISO-format string, convert with df["date"] = df["date"].dt.date)

dictionary

"dict"

object

path

"path"

str (pandas does not have a dedicated path type, validated as str)

url

"url"

str (pandas does not have a dedicated url type, validated as str)

Categorical and relational data types

These are not contained in the DTypeStr Literal.

For any categorical, you can restrict the permissible values to the values defined in a registry. When serializing this to a string, then 'cat[ULabel]' or 'cat[bionty.CellType]' indicate that permissible values are stored in the name field of the ULabel or CellType registry, respectively. You can also restrict to sub-types defined in registries via the type field, e.g., 'cat[ULabel[123456ABCDEFG]]' indicates that values must be of the type with uid="123456ABCDEFG" within the ULabel registry.

In LaminDB, categoricals define relationships with registries. See Feature for more details.

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