lamindb.base.types

Base types.

Central object types

lamindb.base.types.ArtifactKind

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

lamindb.base.types.TransformKind

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

lamindb.base.types.DtypeStr

String-serialized data type.

String-serialized representations of common data types.

Overview

description	lamindb	pandas
numerical	"num"	int | float
integer	"int"	int64 | int32 | int16 | int8 | uint | ...
float	"float"	float64 | float32 | float16 | float8 | ...
string	"str"	object
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)

Categoricals

lamindb allows you to define a registry to which categoricals values are restricted.

For example, '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 column, e.g., 'cat[ULabel[123456ABCDEFG]]' indicates that values must be of the type with uid="123456ABCDEFG" within the ULabel registry.

Literal

A DtypeStr object in lamindb is a Literal up to further specification of "cat".

Basic types

lamindb.base.types.UPathStr

alias of str | Path

lamindb.base.types.StrField

alias of str | DeferredAttribute

lamindb.base.types.ListLike

alias of list[str] | Series | array

lamindb.base.types.FieldAttr

alias of DeferredAttribute