docs: textcat tutorial and small doc fixes (#5055)

sdiazlor · pre-commit-ci[bot] · davidberenstein1957 · web-flow · commit 8c122d4d6939 · 2024-06-19T17:37:49.000+02:00
# Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. Closes #5035 **Type of change** (Remember to title the PR according to the type of change) - [x] Documentation update **How Has This Been Tested** (Please describe the tests that you ran to verify your changes.) `mkdocs serve` --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: David Berenstein <david.m.berenstein@gmail.com>
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,6 +3,7 @@ repos:
     rev: v4.6.0
     hooks:
       - id: check-yaml
+        exclude: argilla/mkdocs.yml
       - id: end-of-file-fixer
         exclude_types: [text, jupyter]
       - id: trailing-whitespace
diff --git a/argilla/docs/community/contributor.md b/argilla/docs/community/contributor.md
@@ -1,5 +1,5 @@
 ---
-description: the Argilla Python SDK is the reference Argilla Python server SDK.
+description: This is a step-by-step guide to help you contribute to the Argilla project. We are excited to have you on board! 🚀
 hide:
   - footer
 ---
diff --git a/argilla/docs/community/index.md b/argilla/docs/community/index.md
@@ -1,5 +1,5 @@
 ---
-description: the Argilla Python SDK is the reference Argilla Python server.
+description: These are the tools and resources to be up-to-date with the Argilla development and contribute to the project.
 hide:
     - toc
     - footer
diff --git a/argilla/docs/getting_started/faq.md b/argilla/docs/getting_started/faq.md
@@ -1,5 +1,5 @@
 ---
-description: the Argilla Python SDK is the reference Argilla Python server.
+description: These are the Frequently Asked Questions regarding Argilla.
 hide: toc
 ---
 
diff --git a/argilla/docs/getting_started/installation.md b/argilla/docs/getting_started/installation.md
@@ -1,5 +1,5 @@
 ---
-description: Installation of the Argilla Python SDK.
+description: Installation of the Argilla SDK.
 ---
 
 # Installation
diff --git a/argilla/docs/how_to_guides/dataset.md b/argilla/docs/how_to_guides/dataset.md
@@ -25,7 +25,7 @@ A **dataset** is a collection of records that you can configure for labelers to
             client=client
         )
         ```
-        > Check the [Dataset - Python Reference](../../reference/argilla/datasets/datasets.md) to see the attributes, arguments, and methods of the `Dataset` class in detail.
+        > Check the [Dataset - Python Reference](../reference/argilla/datasets/datasets.md) to see the attributes, arguments, and methods of the `Dataset` class in detail.
 
     === "`rg.Settings`"
 
@@ -45,7 +45,7 @@ A **dataset** is a collection of records that you can configure for labelers to
         )
         ```
 
-        > Check the [Settings - Python Reference](../../reference/argilla/settings/settings.md) to see the attributes, arguments, and methods of the `Settings` class in detail.
+        > Check the [Settings - Python Reference](../reference/argilla/settings/settings.md) to see the attributes, arguments, and methods of the `Settings` class in detail.
 
 ## Create a dataset
 
diff --git a/argilla/docs/how_to_guides/index.md b/argilla/docs/how_to_guides/index.md
@@ -1,11 +1,11 @@
 ---
-description: These are the how-to guides for the Argilla Python SDK. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
+description: These are the how-to guides for the Argilla SDK. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
 hide: toc
 ---
 
 # How-to guides
 
-These are the how-to guides for *the Argilla Python SDK*. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
+These are the how-to guides for *the Argilla SDK*. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
 
 <div class="grid cards" markdown>
 
diff --git a/argilla/docs/how_to_guides/query_export.md b/argilla/docs/how_to_guides/query_export.md
@@ -18,7 +18,7 @@ You can search for records in your dataset by **querying** or **filtering**. The
             filter=filter
         )
         ```
-        > Check the [Query - Python Reference](../../reference/argilla/search.md) to see the attributes, arguments, and methods of the `Query` class in detail.
+        > Check the [Query - Python Reference](../reference/argilla/search.md) to see the attributes, arguments, and methods of the `Query` class in detail.
 
     === "`rg.Filter`"
 
@@ -29,7 +29,7 @@ You can search for records in your dataset by **querying** or **filtering**. The
             ]
         )
         ```
-        > Check the [Filter - Python Reference](../../reference/argilla/search.md) to see the attributes, arguments, and methods of the `Filter` class in detail.
+        > Check the [Filter - Python Reference](../reference/argilla/search.md) to see the attributes, arguments, and methods of the `Filter` class in detail.
 
 ## Query with search terms
 
diff --git a/argilla/docs/how_to_guides/record.md b/argilla/docs/how_to_guides/record.md
@@ -33,7 +33,7 @@ A **record** in Argilla is a data item that requires annotation, consisting of o
         ],
     )
     ```
-    > Check the [Record - Python Reference](../../reference/argilla/records/records.md) to see the attributes, arguments, and methods of the `Record` class in detail.
+    > Check the [Record - Python Reference](../reference/argilla/records/records.md) to see the attributes, arguments, and methods of the `Record` class in detail.
 
 ## Add records
 
@@ -222,7 +222,7 @@ You can associate vectors, like text embeddings, to your records. They can be us
 
     You can also add vectors to a record in an initialized `Record` object.
 
-    > Check the [Vector - Python Reference](../../reference/argilla/records/vectors.md) to see the attributes, arguments, and methods of the `Vector` class in detail.
+    > Check the [Vector - Python Reference](../reference/argilla/records/vectors.md) to see the attributes, arguments, and methods of the `Vector` class in detail.
 
     ```python
     # Add records to the dataset with the vector 'my_vector' and dimension=3
@@ -274,10 +274,10 @@ You can associate vectors, like text embeddings, to your records. They can be us
 
 Suggestions refer to suggested responses (e.g. model predictions) that you can add to your records to make the annotation process faster. These can be added during the creation of the record or at a later stage. Only one suggestion can be provided for each question, and suggestion values must be compliant with the pre-defined questions e.g. if we have a `RatingQuestion` between 1 and 5, the suggestion should have a valid value within that range.
 
-=== "As `Record objects"
+=== "As `Record` objects"
     You can also add suggestions to a record in an initialized `Record` object.
 
-    > Check the [Suggestions - Python Reference](../../reference/argilla/records/suggestions.md) to see the attributes, arguments, and methods of the `Suggestion` class in detail.
+    > Check the [Suggestions - Python Reference](../reference/argilla/records/suggestions.md) to see the attributes, arguments, and methods of the `Suggestion` class in detail.
 
     ```python
     # Add records to the dataset with the label 'my_label'
@@ -348,7 +348,7 @@ If your dataset includes some annotations, you can add those to the records as y
 === "As `Record` objects"
     You can also add suggestions to a record in an initialized `Record` object.
 
-    > Check the [Responses - Python Reference](../../reference/argilla/records/responses.md) to see the attributes, arguments, and methods of the `Suggestion` class in detail.
+    > Check the [Responses - Python Reference](../reference/argilla/records/responses.md) to see the attributes, arguments, and methods of the `Suggestion` class in detail.
 
     ```python
     # Add records to the dataset with the label 'my_label'
diff --git a/argilla/docs/how_to_guides/user.md b/argilla/docs/how_to_guides/user.md
@@ -2,7 +2,7 @@
 description: In this section, we will provide a step-by-step guide to show how to manage users and their credentials.
 ---
 
-# User Management
+# User management
 
 This guide provides an overview of user roles and credentials, explaining how to set up and manage users in Argilla.
 
@@ -69,7 +69,7 @@ Argilla provides a default user with the `owner` role to help you get started in
         client=client
     )
     ```
-    > Check the [User - Python Reference](../../reference/argilla/users.md) to see the attributes, arguments, and methods of the `User` class in detail.
+    > Check the [User - Python Reference](../reference/argilla/users.md) to see the attributes, arguments, and methods of the `User` class in detail.
 
 ## Get current user
 
diff --git a/argilla/docs/how_to_guides/workspace.md b/argilla/docs/how_to_guides/workspace.md
@@ -2,7 +2,7 @@
 description: In this section, we will provide a step-by-step guide to show how to manage workspaces.
 ---
 
-# Workspace Management
+# Workspace management
 
 This guide provides an overview of workspaces, explaining how to set up and manage workspaces in Argilla.
 
@@ -31,7 +31,7 @@ Argilla provides a default workspace to help you get started in Python and the U
         client=client
     )
     ```
-    > Check the [Workspace - Python Reference](../../reference/argilla/workspaces.md) to see the attributes, arguments, and methods of the `Workspace` class in detail.
+    > Check the [Workspace - Python Reference](../reference/argilla/workspaces.md) to see the attributes, arguments, and methods of the `Workspace` class in detail.
 
 ## Create a new workspace
 
diff --git a/argilla/docs/index.md b/argilla/docs/index.md
@@ -8,7 +8,7 @@ hide: navigation
 Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
 
 !!! SUCCESS "Welcome to Argilla 2.x!"
-    To skip the introductions and go directly to installing and creating your first dataset, see [Quickstart](getting_started/quickstart/).
+    To skip the introductions and go directly to installing and creating your first dataset, see [Quickstart](getting_started/quickstart.md).
 
 !!! DANGER "Looking for Argilla 1.x?"
     Looking for documentation for Argilla 1.x? Visit the latest release [here](https://docs.argilla.io/en/latest/).
diff --git a/argilla/docs/reference/argilla/client.md b/argilla/docs/reference/argilla/client.md
@@ -48,6 +48,6 @@ for dataset in my_workspace.datasets:
 
 ### `rg.Argilla`
 
-::: argilla.client.Argilla
+::: src.argilla.client.Argilla
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/datasets/dataset_records.md b/argilla/docs/reference/argilla/datasets/dataset_records.md
@@ -219,6 +219,6 @@ Check out the [`rg.Record`](../records/records.md) class reference for more info
 
 ### `rg.Dataset.records`
 
-::: argilla.records.DatasetRecords
+::: src.argilla.records._dataset_records.DatasetRecords
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/datasets/datasets.md b/argilla/docs/reference/argilla/datasets/datasets.md
@@ -43,6 +43,6 @@ dataset = client.datasets("my_dataset")
 
 ### `rg.Dataset`
 
-::: argilla.datasets.Dataset
+::: src.argilla.datasets._resource.Dataset
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/records/records.md b/argilla/docs/reference/argilla/records/records.md
@@ -55,6 +55,6 @@ For changes to take effect, the user must call the `update` method on the `Datas
 
 ### `rg.Record`
 
-::: argilla.records.Record
+::: src.argilla.records._resource.Record
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/records/responses.md b/argilla/docs/reference/argilla/records/responses.md
@@ -64,6 +64,6 @@ for record in dataset.records:
 
 ### `rg.Response`
 
-::: argilla.responses.Response
+::: src.argilla.responses.Response
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/records/suggestions.md b/argilla/docs/reference/argilla/records/suggestions.md
@@ -73,6 +73,6 @@ for record in dataset.records(with_suggestions=True):
 
 ### `rg.Suggestion`
 
-::: argilla.suggestions.Suggestion
+::: src.argilla.suggestions.Suggestion
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/records/vectors.md b/argilla/docs/reference/argilla/records/vectors.md
@@ -71,6 +71,6 @@ dataset.records.log(
 
 ### `rg.Vector`
 
-::: argilla.vectors.Vector
+::: src.argilla.vectors.Vector
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/search.md b/argilla/docs/reference/argilla/search.md
@@ -46,12 +46,12 @@ for record in dataset.records(query=query):
 
 ### `rg.Query`
 
-::: argilla.records._search.Query
+::: src.argilla.records._search.Query
     options:
         heading_level: 3
 
 ### `rg.Filter`
 
-::: argilla.records._search.Filter
+::: src.argilla.records._search.Filter
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/settings/fields.md b/argilla/docs/reference/argilla/settings/fields.md
@@ -39,6 +39,6 @@ data = rg.Dataset(
 
 ### `rg.TextField`
 
-::: argilla.settings.TextField
+::: src.argilla.settings._field.TextField
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/settings/metadata_property.md b/argilla/docs/reference/argilla/settings/metadata_property.md
@@ -69,18 +69,18 @@ dataset = rg.Dataset(
 
 ### `rg.FloatMetadataProperty`
 
-::: argilla.settings.FloatMetadataProperty
+::: src.argilla.settings._metadata.FloatMetadataProperty
     options:
         heading_level: 3
 
 ### `rg.IntegerMetadataProperty`
 
-::: argilla.settings.IntegerMetadataProperty
+::: src.argilla.settings._metadata.IntegerMetadataProperty
     options:
         heading_level: 3
 
 ### `rg.TermsMetadataProperty`
 
-::: argilla.settings.TermsMetadataProperty
+::: src.argilla.settings._metadata.TermsMetadataProperty
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/settings/questions.md b/argilla/docs/reference/argilla/settings/questions.md
@@ -57,36 +57,36 @@ dataset = rg.Dataset(
 
 ### `rg.LabelQuestion`
 
-::: argilla.settings.LabelQuestion
+::: src.argilla.settings._question.LabelQuestion
     options:
         heading_level: 3
 
 ### `rg.MultiLabelQuestion`
 
-::: argilla.settings.MultiLabelQuestion
+::: src.argilla.settings._question.MultiLabelQuestion
     options:
         heading_level: 3
 
 ### `rg.RankingQuestion`
 
-::: argilla.settings.RankingQuestion
+::: src.argilla.settings._question.RankingQuestion
     options:
         heading_level: 3
 
 ### `rg.TextQuestion`
 
-::: argilla.settings.TextQuestion
+::: src.argilla.settings._question.TextQuestion
     options:
         heading_level: 3
 
 ### `rg.RatingQuestion`
 
-::: argilla.settings.RatingQuestion
+::: src.argilla.settings._question.RatingQuestion
     options:
         heading_level: 3
 
 ### `rg.SpanQuestion`
 
-::: argilla.settings.SpanQuestion
+::: src.argilla.settings._question.SpanQuestion
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/settings/settings.md b/argilla/docs/reference/argilla/settings/settings.md
@@ -38,6 +38,6 @@ dataset.create()
 
 ### `rg.Settings`
 
-::: argilla.settings.Settings
+::: src.argilla.settings._resource.Settings
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/settings/vectors.md b/argilla/docs/reference/argilla/settings/vectors.md
@@ -32,6 +32,6 @@ settings = rg.Settings(
 
 ### `rg.VectorField`
 
-::: argilla.settings.VectorField
+::: src.argilla.settings._vector.VectorField
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/users.md b/argilla/docs/reference/argilla/users.md
@@ -32,6 +32,6 @@ client.me
 
 ### `rg.User`
 
-::: argilla.users.User
+::: src.argilla.users._resource.User
     options:
         heading_level: 3
diff --git a/argilla/docs/reference/argilla/workspaces.md b/argilla/docs/reference/argilla/workspaces.md
@@ -27,6 +27,6 @@ workspace = client.workspaces("my_workspace")
 
 ### `rg.Workspace`
 
-::: argilla.workspaces.Workspace
+::: src.argilla.workspaces._resource.Workspace
     options:
         heading_level: 4
diff --git a/argilla/docs/scripts/gen_popular_issues.py b/argilla/docs/scripts/gen_popular_issues.py
@@ -86,6 +86,9 @@ def get_org_members(auth_token):
 
     members_url = "https://api.github.com/orgs/argilla-io/members"
 
+    if auth_token is None:
+        return []
+
     while members_url:
         response = requests.get(members_url, headers=headers)
         members = response.json()
diff --git a/argilla/docs/tutorials/index.md b/argilla/docs/tutorials/index.md
@@ -0,0 +1,20 @@
+---
+description: These are the tutorials for the Argilla SDK. They provide step-by-step instructions for common tasks.
+hide: toc
+---
+
+
+# Tutorials
+
+These are the tutorials for *the Argilla SDK*. They provide step-by-step instructions for common tasks.
+
+<div class="grid cards" markdown>
+
+-   __Text classification task__
+
+    ---
+
+    Learn about a standard workflow to improve data quality for a text classification task.
+    [:octicons-arrow-right-24: How-to guide](text_classification.ipynb)
+
+</div>
diff --git a/argilla/docs/tutorials/text_classification.ipynb b/argilla/docs/tutorials/text_classification.ipynb
diff --git a/argilla/mkdocs.yml b/argilla/mkdocs.yml

-Original file line number
+Diff line change
@@ @@ -1,5 +1,5 @@ @@
 ---
 -description: the Argilla Python SDK is the reference Argilla Python server SDK.
 +description: This is a step-by-step guide to help you contribute to the Argilla project. We are excited to have you on board! 🚀
 hide:
   - footer
 ---
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ A dataset is a collection of records that you can configure for labelers to`
`25`	`25`	`client=client`
`26`	`26`	`)`
`27`	`27`	```
`28`		- > Check the [Dataset - Python Reference](../../reference/argilla/datasets/datasets.md) to see the attributes, arguments, and methods of the `Dataset` class in detail.
	`28`	+ > Check the [Dataset - Python Reference](../reference/argilla/datasets/datasets.md) to see the attributes, arguments, and methods of the `Dataset` class in detail.
`29`	`29`
`30`	`30`	=== "`rg.Settings`"
`31`	`31`
`@@ -45,7 +45,7 @@ A dataset is a collection of records that you can configure for labelers to`
`45`	`45`	`)`
`46`	`46`	```
`47`	`47`
`48`		- > Check the [Settings - Python Reference](../../reference/argilla/settings/settings.md) to see the attributes, arguments, and methods of the `Settings` class in detail.
	`48`	+ > Check the [Settings - Python Reference](../reference/argilla/settings/settings.md) to see the attributes, arguments, and methods of the `Settings` class in detail.
`49`	`49`
`50`	`50`	`## Create a dataset`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ You can search for records in your dataset by querying or filtering. The`
`18`	`18`	`filter=filter`
`19`	`19`	`)`
`20`	`20`	```
`21`		- > Check the [Query - Python Reference](../../reference/argilla/search.md) to see the attributes, arguments, and methods of the `Query` class in detail.
	`21`	+ > Check the [Query - Python Reference](../reference/argilla/search.md) to see the attributes, arguments, and methods of the `Query` class in detail.
`22`	`22`
`23`	`23`	=== "`rg.Filter`"
`24`	`24`
`@@ -29,7 +29,7 @@ You can search for records in your dataset by querying or filtering. The`
`29`	`29`	`]`
`30`	`30`	`)`
`31`	`31`	```
`32`		- > Check the [Filter - Python Reference](../../reference/argilla/search.md) to see the attributes, arguments, and methods of the `Filter` class in detail.
	`32`	+ > Check the [Filter - Python Reference](../reference/argilla/search.md) to see the attributes, arguments, and methods of the `Filter` class in detail.
`33`	`33`
`34`	`34`	`## Query with search terms`
`35`	`35`