From ca103bb5fa0b674132f8ccc474ed465b0cdd57f2 Mon Sep 17 00:00:00 2001 From: Alex Wolf Date: Thu, 28 Nov 2024 13:52:08 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- lnschema_core/models.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lnschema_core/models.py b/lnschema_core/models.py index c866d4a3..4d6298ae 100644 --- a/lnschema_core/models.py +++ b/lnschema_core/models.py @@ -1226,7 +1226,7 @@ class Meta(Record.Meta, TracksRun.Meta, TracksUpdates.Meta): name: str = CharField(max_length=100, db_index=True) dtype: str = CharField(max_length=64, db_index=True) - """Data type ("number", "cat", "int", "float", "bool", "datetime"). + """Data type ("num", "cat", "int", "float", "bool", "datetime"). For categorical types, can define from which registry values are sampled, e.g., `cat[ULabel]` or `cat[bionty.CellType]`. @@ -1530,7 +1530,7 @@ class Feature(Record, CanCurate, TracksRun, TracksUpdates): Args: name: `str` Name of the feature, typically. column name. - dtype: `str | list[Type[Record]]` Data type ("number", "cat", "int", "float", "bool", "datetime"). + dtype: `str | list[Type[Record]]` Data type ("num", "cat", "int", "float", "bool", "datetime"). For categorical types, can define from which registry values are sampled, e.g., `cat[ULabel]` or `cat[bionty.CellType]`. unit: `str | None = None` Unit of measure, ideally SI (`"m"`, `"s"`, `"kg"`, etc.) or `"normalized"` etc. @@ -1593,7 +1593,7 @@ class Meta(Record.Meta, TracksRun.Meta, TracksUpdates.Meta): name: str = CharField(max_length=150, db_index=True, unique=True) """Name of feature (required).""" dtype: str = CharField(max_length=64, db_index=True) - """Data type ("number", "cat", "int", "float", "bool", "datetime"). + """Data type ("num", "cat", "int", "float", "bool", "datetime"). For categorical types, can define from which registry values are sampled, e.g., `cat[ULabel]` or `cat[bionty.CellType]`. @@ -1705,7 +1705,7 @@ class FeatureSet(Record, TracksRun): :meth:`~lamindb.FeatureSet.from_df`. dtype: `str | None = None` The simple type. Defaults to `None` for sets of :class:`~lamindb.Feature` records. nd otherwise - defaults to `"number"` (e.g., for sets of :class:`~bionty.Gene`). + defaults to `"num"` (e.g., for sets of :class:`~bionty.Gene`). name: `str | None = None` A name. Note: @@ -1764,7 +1764,7 @@ class Meta(Record.Meta, TracksRun.Meta, TracksUpdates.Meta): n = IntegerField() """Number of features in the set.""" dtype: str | None = CharField(max_length=64, null=True) - """Data type, e.g., "number", "float", "int". Is `None` for :class:`~lamindb.Feature`. + """Data type, e.g., "num", "float", "int". Is `None` for :class:`~lamindb.Feature`. For :class:`~lamindb.Feature`, types are expected to be heterogeneous and defined on a per-feature level. """