Skip to content

Commit c1fbe9c

Browse files
paupaizfalexwolf
andauthored
🩹 Update glossary (#217)
* Update glossary.md * Re-concile record & registry * Some ordering and polishing --------- Co-authored-by: Alex Wolf <[email protected]>
1 parent c99eb42 commit c1fbe9c

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

‎docs/glossary.md

+25-4
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,24 @@
22

33
```{glossary}
44
5+
artifact
6+
Stores a dataset or model as a file or folder.
7+
8+
curator
9+
- Object class designed to ensure your dataset conforms to a desired schema.
10+
- Helps with validation, standardization (e.g., by fixing typos or mapping synonyms), and annotation (linking it against metadata entities so that it becomes queryable).
11+
512
FAIR
613
FAIR data is data which meets the principles of findability, accessibility, interoperability, and reusability [wikipedia](https://en.wikipedia.org/wiki/FAIR_data).
714
8-
UI
9-
Graphical user interface, for instance, a browser-based data catalog.
10-
1115
feature
1216
A feature is a property of a measurement [[Wikipedia](https://en.wikipedia.org/wiki/Feature_(machine_learning))]. It's equivalent to a {term}`variable` in statistics and is typically equated with a dimension of a dataset.
1317
1418
LaminDB comes with a {class}`~lamindb.Feature` registry to organize dataset dimensions and equates them with statistical variables.
1519
20+
instance
21+
Shorthand for "LaminDB instance", a database that manages metadata for datasets in different storage locations.
22+
1623
label
1724
A label refers to a descriptor or tag that is assigned to something to describe, identify, or categorize it.
1825
@@ -30,7 +37,9 @@ observation
3037
record
3138
A record is a data structure that consists in a sequence of typed [fields](https://en.wikipedia.org/wiki/Field_(computer_science)) that hold values [[Wikipedia](https://en.wikipedia.org/wiki/Record_(computer_science))].
3239
33-
In LaminDB, a metadata record is modeled as a {class}`~lamindb.models.Record`.
40+
In LaminDB, a metadata record is modeled as a {class}`~lamindb.models.Record` and represents a row in a in a reqistry (a table in the SQL database).
41+
42+
It automatically sets up important behaviors and methods (like filtering, querying, and converting records to DataFrames) needed to interact with the metadata database.
3443
3544
sample
3645
In biology, a sample is an instance or part of a biological system.
@@ -49,4 +58,16 @@ variable
4958
5059
A dependent variable is sometimes called a "response variable", "regressand", "criterion", "predicted variable", "measured variable", "explained variable", "experimental variable", "responding variable", "outcome variable", "output variable", "target" or "label".
5160
61+
schema
62+
Blueprint for your data’s structure. Tool for curating and validating the organization of your data, helping maintain data integrity as it evolves through various processing steps.
63+
64+
registry
65+
A table in a SQL database (SQLite/Postgres) holding records.
66+
67+
transform
68+
A piece of code (script, notebook, pipeline, function) that can be applied to input data to produce output data.
69+
70+
UI
71+
Graphical user interface, for instance, a browser-based data catalog.
72+
5273
```

0 commit comments

Comments
 (0)