Skip to content

Commit

Permalink
💄 Polish introduction.ipynb
Browse files Browse the repository at this point in the history
  • Loading branch information
falexwolf committed Jan 16, 2025
1 parent a3623d1 commit 6ceebfc
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/introduction.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
"outputs": [],
"source": [
"# manage artifacts in local directory `./lamin-intro`\n",
"!lamin init --storage ./lamin-intro --schema bionty"
"!lamin init --storage ./lamin-intro --modules bionty"
]
},
{
Expand Down Expand Up @@ -1200,13 +1200,13 @@
"For learning more about how to create & host LaminDB instances on distributed infrastructure, see {doc}`setup`. LaminDB instances work standalone but can optionally be managed by LaminHub. For an architecture diagram of LaminHub, [reach out](https://lamin.ai/contact)!\n",
"\n",
"\n",
"### Metada schema & API\n",
"### Registry schema & API\n",
"\n",
"<img src=\"https://lamin-site-assets.s3.amazonaws.com/.lamindb/XoTQFCmmj2uU4d2xyj9u.png\" width=\"350px\" style=\"background: transparent\" align=\"right\">\n",
"\n",
"LaminDB provides a SQL schema for common metadata entities: {class}`~lamindb.Artifact`, {class}`~lamindb.Collection`, {class}`~lamindb.Transform`, {class}`~lamindb.Feature`, {class}`~lamindb.ULabel` etc. - see the [API reference](/api) or the [source code](https://github.com/laminlabs/lnschema-core/blob/main/lnschema_core/models.py).\n",
"\n",
"The core metadata schema is extendable through plugins (see green vs. red entities in **graphic**), e.g., with basic biological ({class}`~bionty.Gene`, {class}`~bionty.Protein`, {class}`~bionty.CellLine`, etc.) & operational entities (`Biosample`, `Techsample`, `Treatment`, etc.).\n",
"The core metadata schema is extendable through modules (see green vs. red entities in **graphic**), e.g., with basic biological ({class}`~bionty.Gene`, {class}`~bionty.Protein`, {class}`~bionty.CellLine`, etc.) & operational entities (`Biosample`, `Techsample`, `Treatment`, etc.).\n",
"\n",
"```{dropdown} What is the metadata schema language?\n",
"\n",
Expand All @@ -1217,16 +1217,16 @@
"\n",
"On top of the metadata schema, LaminDB is a Python API that models datasets as artifacts, abstracts over storage & database access, data transformations, and (biological) ontologies.\n",
"\n",
"Note that the datasets schema (e.g., `.parquet` files or `.h5ad` arrays) is modeled through the `Feature` registry and does not require migrations to be updated.\n",
"Note that the schemas of datasets (e.g., `.parquet` files, `.h5ad` arrays, etc.) are modeled through the `Feature` registry and do not require migrations to be updated.\n",
"\n",
"### Custom schemas and plugins\n",
"### Custom registries\n",
"\n",
"LaminDB can be customized & extended with schema & app plugins building on the [Django](https://github.com/django/django) ecosystem. Examples are:\n",
"LaminDB can be extended with registry modules building on the [Django](https://github.com/django/django) ecosystem. Examples are:\n",
"\n",
"- [bionty](./bionty): Registries for basic biological entities, coupled to public ontologies.\n",
"- [wetlab](https://github.com/laminlabs/wetlab): Registries for samples, treatments, etc.\n",
"\n",
"If you'd like to create your own schema or app:\n",
"If you'd like to create your own module:\n",
"\n",
"1. Create a git repository with registries similar to [wetlab](https://github.com/laminlabs/wetlab)\n",
"2. Create & deploy migrations via `lamin migrate create` and `lamin migrate deploy`\n",
Expand All @@ -1242,7 +1242,6 @@
"\n",
"All immediate dependencies are available as git submodules [here](https://github.com/laminlabs/lamindb/tree/main/sub), for instance,\n",
"\n",
"- [lnschema-core](https://github.com/laminlabs/lnschema-core): Core schema.\n",
"- [lamindb-setup](https://github.com/laminlabs/lamindb-setup): Setup & configure LaminDB.\n",
"- [lamin-cli](https://github.com/laminlabs/lamin-cli): CLI for `lamindb` and `lamindb-setup`.\n",
"\n",
Expand Down

0 comments on commit 6ceebfc

Please sign in to comment.