From 7729fb4dacd27e8ea71116a64e78389f6956f522 Mon Sep 17 00:00:00 2001 From: sdiazlor Date: Thu, 13 Jun 2024 16:14:19 +0200 Subject: [PATCH] docs: fix reference docs --- argilla/docs/reference/argilla/client.md | 2 +- .../reference/argilla/datasets/dataset_records.md | 2 +- argilla/docs/reference/argilla/datasets/datasets.md | 2 +- argilla/docs/reference/argilla/records/records.md | 2 +- argilla/docs/reference/argilla/records/responses.md | 2 +- .../docs/reference/argilla/records/suggestions.md | 2 +- argilla/docs/reference/argilla/records/vectors.md | 2 +- argilla/docs/reference/argilla/search.md | 4 ++-- argilla/docs/reference/argilla/settings/fields.md | 2 +- .../reference/argilla/settings/metadata_property.md | 6 +++--- argilla/docs/reference/argilla/settings/questions.md | 12 ++++++------ argilla/docs/reference/argilla/settings/settings.md | 2 +- argilla/docs/reference/argilla/settings/vectors.md | 2 +- argilla/docs/reference/argilla/users.md | 2 +- argilla/docs/reference/argilla/workspaces.md | 2 +- 15 files changed, 23 insertions(+), 23 deletions(-) diff --git a/argilla/docs/reference/argilla/client.md b/argilla/docs/reference/argilla/client.md index 194bf61f5f..e4be355557 100644 --- 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 index 919e7eb0f8..e082f9773d 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/datasets/datasets.md b/argilla/docs/reference/argilla/datasets/datasets.md index d9cf78a024..013e774b44 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/records/records.md b/argilla/docs/reference/argilla/records/records.md index 59f22aed85..5aaef9f5c1 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/records/responses.md b/argilla/docs/reference/argilla/records/responses.md index 028fcd8db8..f6b79a7b0b 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/records/suggestions.md b/argilla/docs/reference/argilla/records/suggestions.md index 3a8508721e..38d3c6f6a5 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/records/vectors.md b/argilla/docs/reference/argilla/records/vectors.md index 6a78908f13..5d8e8384f5 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/search.md b/argilla/docs/reference/argilla/search.md index 305953d5a2..7ed9df23a0 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/settings/fields.md b/argilla/docs/reference/argilla/settings/fields.md index e482ce3836..5c30e222a5 100644 --- 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 index a33f0075cf..6f1cd4a7c0 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/settings/questions.md b/argilla/docs/reference/argilla/settings/questions.md index 08b9b33a5c..a4f45b5b91 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/settings/settings.md b/argilla/docs/reference/argilla/settings/settings.md index 677bc16b59..9510a6e18f 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/settings/vectors.md b/argilla/docs/reference/argilla/settings/vectors.md index 7d00f802b6..91e0be3f05 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/users.md b/argilla/docs/reference/argilla/users.md index 0c79dd8644..e91c58a10d 100644 --- 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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/workspaces.md b/argilla/docs/reference/argilla/workspaces.md index f56ee1596f..dcd1b7a425 100644 --- 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 \ No newline at end of file