Skip to content

Commit

Permalink
docs: corrected for tutorial and api redirections (#1820)
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidberenstein1957
davidberenstein1957 committed Nov 3, 2022
1 parent e880100 commit 26ccdcc
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 31 deletions.
6 changes: 3 additions & 3 deletions docs/_source/guides/features/datasets.ipynb
View file
Expand Up @@ -11,7 +11,7 @@
"The Dataset classes are lightweight containers for Argilla records. These classes facilitate importing from and exporting to different formats (e.g., `pandas.DataFrame`, `datasets.Dataset`) as well as sharing and versioning Argilla datasets using the Hugging Face Hub.\n",
"\n",
"For each record type there's a corresponding Dataset class called `DatasetFor<RecordType>`.\n",
"You can look up their API in the [reference section](../reference/python/python_client.rst#module-argilla.client.datasets)"
"You can look up their API in the [reference section](../../reference/python/python_client.rst#module-argilla.client.datasets)"
]
},
{
Expand Down Expand Up @@ -67,13 +67,13 @@
"You have to make sure that the data follows the record model of a specific task, otherwise you will get validation errors. \n",
"Columns in your DataFrame/Dataset that are not supported or recognized, will simply be ignored.\n",
"\n",
"The record models of the tasks are explained in the [reference section](../reference/python/python_client.rst#module-argilla.client.models). \n",
"The record models of the tasks are explained in the [reference section](../../reference/python/python_client.rst#module-argilla.client.models). \n",
"\n",
"<div class=\"alert alert-info\">\n",
"\n",
"Note\n",
"\n",
"Due to it's pyarrow nature, data in a `datasets.Dataset` has to follow a slightly different model, that you can look up in the examples of the `Dataset*.from_datasets` [docstrings](../reference/python/python_client.rst#argilla.client.datasets.DatasetForTokenClassification.from_datasets). \n",
"Due to it's pyarrow nature, data in a `datasets.Dataset` has to follow a slightly different model, that you can look up in the examples of the `Dataset*.from_datasets` [docstrings](../../reference/python/python_client.rst#argilla.client.datasets.DatasetForTokenClassification.from_datasets). \n",
" \n",
"</div>"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/_source/guides/features/metrics.ipynb
View file
Expand Up @@ -11,7 +11,7 @@
"\n",
"The main goal is to make it easier to build more robust models and training data, going beyond single-number metrics (e.g., F1). \n",
"\n",
"This guide gives a brief overview of currently supported metrics. For the full API documentation see the [Python API reference](../reference/python/python_metrics.rst)\n",
"This guide gives a brief overview of currently supported metrics. For the full API documentation see the [Python API reference](../../reference/python/python_metrics.rst)\n",
"\n",
"\n",
".. nbinfo::\n",
Expand Down
54 changes: 27 additions & 27 deletions docs/_source/guides/features/queries.md
View file
Expand Up @@ -48,7 +48,7 @@ You can see how the `text.exact` field can be used to search in a more fine-grai

### TextClassificationRecord's `inputs`

For [text classification records](../python/python_client.rst#argilla.client.models.TextClassificationRecord) you can take advantage of the multiple `inputs` when performing a search.
For [text classification records](../../python/python_client.rst#argilla.client.models.TextClassificationRecord) you can take advantage of the multiple `inputs` when performing a search.
For example, if we uploaded records with `inputs={"subject": ..., "body": ...}`, you can direct your searches to only one of those inputs by specifying the `inputs.subject` or `inputs.body` field in your query.
So to look for records in which the *subject* contains the word *news*, you would search for

Expand Down Expand Up @@ -150,8 +150,8 @@ For instance, to search for *"(1+1)=2"* you need to write:

This is a table with available fields that you can use in your query string:

| Field name | Description | TextClass. | TokenClass. | TextGen. |
|------------------------------------------|---------------------------------------|--------------------------------------------|---------------------------------------------|---------------------------------------------|
| Field name | Description | TextClass. | TokenClass. | TextGen. |
| ---------------------------------------- | ------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| annotated_as | annotation | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> |
| annotated_by | annotation agent | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> |
| event_timestamp | timestamp | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> |
Expand All @@ -165,29 +165,29 @@ This is a table with available fields that you can use in your query string:
| status | status | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> |
| text | text, standard analyzer | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> |
| text.exact | text, whitespace analyzer | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> |
| tokens | tokens | | <p style="text-align: center;">&#10004;</p> | |
| - | - | - | - | - |
| tokens | tokens | | <p style="text-align: center;">&#10004;</p> | |
| - | - | - | - | - |
| metrics.text_lengt | Input text length | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> | <p style="text-align: center;">&#10004;</p> |
| metrics.tokens.idx | Token idx in record | | <p style="text-align: center;">&#10004;</p> | |
| metrics.tokens.value | Text of the token | | <p style="text-align: center;">&#10004;</p> | |
| metrics.tokens.char_start | Start char idx of token | | <p style="text-align: center;">&#10004;</p> | |
| metrics.tokens.char_end | End char idx of token | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.value | Text of the mention (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.label | Label of the mention (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.score | Score of the mention (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.capitalness | Mention capitalness (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.density | Local mention density (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.tokens_length | Mention length in tokens (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.chars_length | Mention length in chars (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.tags.value | Text of the token (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.tags.tag | IOB tag (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.value | Text of the mention (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.label | Label of the mention (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.score | Score of the mention (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.capitalness | Mention capitalness (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.density | Local mention density (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.tokens_length | Mention length in tokens (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.chars_length | Mention length in chars (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.tags.value | Text of the token (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.tags.tag | IOB tag (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.tokens.idx | Token idx in record | | <p style="text-align: center;">&#10004;</p> | |
| metrics.tokens.value | Text of the token | | <p style="text-align: center;">&#10004;</p> | |
| metrics.tokens.char_start | Start char idx of token | | <p style="text-align: center;">&#10004;</p> | |
| metrics.tokens.char_end | End char idx of token | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.value | Text of the mention (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.label | Label of the mention (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.score | Score of the mention (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.capitalness | Mention capitalness (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.density | Local mention density (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.tokens_length | Mention length in tokens (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.mentions.chars_length | Mention length in chars (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.tags.value | Text of the token (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.annotated.tags.tag | IOB tag (annotation) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.value | Text of the mention (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.label | Label of the mention (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.score | Score of the mention (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.capitalness | Mention capitalness (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.density | Local mention density (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.tokens_length | Mention length in tokens (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.mentions.chars_length | Mention length in chars (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.tags.value | Text of the token (prediction) | | <p style="text-align: center;">&#10004;</p> | |
| metrics.predicted.tags.tag | IOB tag (prediction) | | <p style="text-align: center;">&#10004;</p> | |

0 ...assification-skweak-weaksupervision.ipynb → ...assification-skweak-weaksupervision.ipynb
View file
File renamed without changes.

0 comments on commit 26ccdcc

Please sign in to comment.