Skip to content

Commit

Permalink
docs: include references about how to reindex datasets in hf spaces (#…
Browse files Browse the repository at this point in the history
…4610)

<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

This PR adds documentation related to how to reindex feedback datasets
for search when using quickstart images.

Closes #4603 

**Type of change**

(Remember to title the PR according to the type of change)

- [X] Documentation update

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
frascuchon and pre-commit-ci[bot] authored Feb 28, 2024
1 parent ceb9a37 commit bfb8ea1
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -235,3 +235,11 @@ argilla server search-engine reindex --feedback-dataset-id 08476931-ac30-4eec-9a
:::

::::

If you are using the quickstart docker image, you can set the `REINDEX_DATASETS` environment variable to `true` to reindex the datasets.
You can visit the [Docker Quickstart](/getting_started/installation/deployments/docker-quickstart) deployment page for more information.

:::

::::

Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- Argilla Server and UI
```
```{grid-item-card} Docker Quickstart
:link: docker.md
:link: docker-quickstart.md
- A combined Docker image
- Environment Variables
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,8 @@ This will run the latest quickstart docker image with 3 users `owner`, `admin` a
supported values for this variable are as follows:
1. `single`: Load single datasets for Feedback task.
2. `full`: Load all the sample datasets for NLP tasks (Feedback, TokenClassification, TextClassification, Text2Text)
3. `none`: No datasets are loaded.
3. `none`: No datasets are loaded.
- `REINDEX_DATASETS`: This variable will allow you to reindex the datasets. This must be done when a new version includes changes in the search index definition.
The default value will be `false`. The supported values for this variable are as follows:
1. `true`: Reindex the datasets.
2. `false`: Do not reindex the datasets.

0 comments on commit bfb8ea1

Please sign in to comment.