docs: add dataset settings page and update section about defining lab…

…eling schemas (#2558) # Description Adds a section to the docs about the Dataset Settings page under Reference > Argilla UI > Pages. Updates the section "Define a labeling schema" in "Log, load, and prepare data" guide. **Type of change** (Please delete options that are not relevant. Remember to title the PR according to the type of change) - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Refactor (change restructuring the codebase without changing functionality) - [ ] Improvement (change adding some improvement to an existing functionality) - [x] Documentation update **How Has This Been Tested** (Please describe the tests that you ran to verify your changes. And ideally, reference `tests`) - [ ] Test A - [ ] Test B **Checklist** - [x] I have merged the original branch into my forked branch - [ ] I added relevant documentation - [ ] follows the style guidelines of this project - [x ] I did a self-review of my code - [x ] I made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- Co-authored-by: keithCuniah <[email protected]> Co-authored-by: leiyre <[email protected]> Co-authored-by: Keith Cuniah <[email protected]> Co-authored-by: frascuchon <[email protected]> Co-authored-by: leire <[email protected]> Co-authored-by: keithCuniah <[email protected]>
argilla-io · Mar 16, 2023 · dcabc4e · dcabc4e
1 parent ff81ca9
commit dcabc4e
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add new page and components for dataset settings. Closes [#2442](https://github.com/argilla-io/argilla/issues/2003)
 
 
+### Changed
+- Labels are now centralized in a specific vuex ORM called GlobalLabel Model, see https://github.com/argilla-io/argilla/issues/2210. This model is the same for TokenClassification and TextClassification (so both task have labels with color_id and shortcuts parameters in the vuex ORM)
+- The shortcuts improvement for labels [#2339](https://github.com/argilla-io/argilla/pull/2339) have been moved to the vuex ORM in dataset settings feature [#2444](https://github.com/argilla-io/argilla/commit/eb37c3bcff3ad253481d6a10f8abb093384f2dcb)
+- Update "Define a labeling schema" section in docs.
+
+
 ### Fixes
 
 - Allow URL to be clickable in Jupyter notebook again. Closes [#2527](https://github.com/argilla-io/argilla/issues/2527)
@@ -25,6 +31,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Remove the previous way to add labels through the dataset page. Now labels can be added only through dataset settings page.
 
 
-### Changed
-- Labels are now centralized in a specific vuex ORM called GlobalLabel Model, see https://github.com/argilla-io/argilla/issues/2210. This model is the same for TokenClassification and TextClassification (so both task have labels with color_id and shortcuts parameters in the vuex ORM)
-- The shortcuts impovement for labels [#2339](https://github.com/argilla-io/argilla/pull/2339) have been moved to the vuex ORM in dataset settings feature [#2444](https://github.com/argilla-io/argilla/commit/eb37c3bcff3ad253481d6a10f8abb093384f2dcb)
diff --git a/docs/_source/_static/images/guides/guides-define_schema.png b/docs/_source/_static/images/guides/guides-define_schema.png
diff --git a/docs/_source/_static/reference/webapp/pages-dataset_settings.png b/docs/_source/_static/reference/webapp/pages-dataset_settings.png
diff --git a/docs/_source/guides/log_load_and_prepare_data.ipynb b/docs/_source/guides/log_load_and_prepare_data.ipynb
@@ -240,6 +240,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "ee0f9b20",
    "metadata": {},
@@ -249,9 +250,9 @@
     "Argilla datasets have certain *settings* that you can configure via the `rg.*Settings` classes, for example `rg.TextClassificationSettings`.\n",
     "\n",
     "### Define a labeling schema\n",
-    "\n",
     "You can define a labeling schema for your Argilla dataset, which fixes the allowed labels for your predictions and annotations.\n",
-    "Once you set a labeling schema, each time you log to the corresponding dataset, Argilla will perform validations of the added predictions and annotations to make sure they comply with the schema."
+    "Once you set a labeling schema, each time you log to the corresponding dataset, Argilla will perform validations of the added predictions and annotations to make sure they comply with the schema.\n",
+    "You can set your labels using the code below or from the [Dataset settings page](../reference/webapp/pages.md#dataset-settings) in the UI."
    ]
   },
   {
@@ -276,6 +277,17 @@
     "# BadRequestApiError: Argilla server returned an error with http status: 400\n"
    ]
   },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "03ffc721",
+   "metadata": {},
+   "source": [
+    "If you forget to define a labeling schema, Argilla will aggregate the labels it finds in the dataset automatically, but you will need to validate it. To do this, go to your [Dataset settings page](../reference/webapp/pages.md#dataset-settings) and click _Save schema_.\n",
+    "\n",
+    "![Schema not saved](../../_source/_static/images/guides/guides-define_schema.png)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "8ec833d8-b0a1-415a-9d31-5ef1205d3ebb",
@@ -808,7 +820,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -822,11 +834,11 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.12"
+   "version": "3.9.6"
   },
   "vscode": {
    "interpreter": {
-    "hash": "2584bca9d226488c39a669ff1ce19d7ca5f410e2d3aa9b82f20653edd0d96bfc"
+    "hash": "31f2aee4e71d21fbe5cf8b01ff0e069b9275f58929596ceb00d14d90e3e16cd6"
    }
   }
  },

diff --git a/docs/_source/reference/webapp/pages.md b/docs/_source/reference/webapp/pages.md
@@ -1,4 +1,3 @@
-(pages)=
 # Pages
 
 ## Home page
@@ -124,3 +123,21 @@ You can find more information about each metric in our dedicated [metrics guide]
 
 This button allows you to refresh the list of the record cards with respect to the activated filters.
 For example, if you are annotating and use the [Status filter](./features.md) to filter out annotated records, you can press the _Refresh_ button to hide the latest annotated records.
+
+
+## Dataset settings
+![Dataset page](../../_static/reference/webapp/pages-dataset_settings.png)
+
+You can access this page by clicking on the settings icon next to the user icon inside of the Dataset view.
+
+In this page, you will be able to access the settings of a specific dataset and make modifications.
+
+### Description and annotation guidelines
+
+Soon you will be able to edit this information.
+
+### Labels
+Here you can [define your labeling schema](../../guides/log_load_and_prepare_data.ipynb#update-a-dataset) for this dataset, see the current one and add new labels to it.
+
+### Danger zone
+In this area, you will find a button to delete the current dataset.