Skip to content
This repository has been archived by the owner on Jan 2, 2025. It is now read-only.

Commit

Permalink
📝 Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
falexwolf committed Nov 28, 2024
1 parent 5c4f172 commit ca103bb
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions lnschema_core/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]`.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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]`.
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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.
"""
Expand Down

0 comments on commit ca103bb

Please sign in to comment.