Skip to content

Commit

Permalink
Docs/review docker readme (#5325)
Browse files Browse the repository at this point in the history
# 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 #<issue_number>

**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)
- Documentation update

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm 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: Daniel Vila Suero <[email protected]>
  • Loading branch information
frascuchon and dvsrepo authored Jul 29, 2024
1 parent b4ecd3d commit 9feb7b1
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/argilla-server.build-docker-images.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ jobs:
username: ${{ env.DOCKER_USERNAME }}
password: ${{ env.DOCKER_PASSWORD }}
repository: $${{ env.SERVER_DOCKER_IMAGE }}
readme-filepath: argilla-server/README.md
readme-filepath: argilla-server/docker/server/README.md

- name: Docker Hub Description for `argilla-hf-spaces`
uses: peter-evans/dockerhub-description@v4
Expand Down
13 changes: 13 additions & 0 deletions argilla-server/docker/argilla-hf-spaces/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,16 @@ Argilla is a **collaboration tool for AI engineers and domain experts** that req
## Why use Argilla?

Whether you are working on monitoring and improving complex **generative tasks** involving LLM pipelines with RAG, or you are working on a **predictive task** for things like AB-testing of span- and text-classification models. Our versatile platform helps you ensure **your data work pays off**.

### Environment variables

Besides the common environment variables defined in docs, this Docker image provides a set of variables to simplify the server startup:

- `USERNAME`: If provided, the owner username. This can be combined with HF OAuth to define the argilla server owner (Default to `$SPACE_AUTHOR_NAME`).

- `PASSWORD`: If provided, the owner password. If `USERNAME` and `PASSWORD` are provided, the owner user will be created with these credentials on the server startup (Default: `""`).

- `API_KEY`: If provided, the owner api key. When `USERNAME` and `PASSWORD` are provided and `API_KEY` is empty, a new random value will be generated (Default: `""`).

- `REINDEX_DATASET`: If `true` or `1`, the datasets will be reindexed in the search engine. This setting must be kept enabled when running in HF spaces (Default: `1`).

28 changes: 28 additions & 0 deletions argilla-server/docker/server/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<h1 align="center">
<a href=""><img src="https://github.com/dvsrepo/imgs/raw/main/rg.svg" alt="Argilla" width="150"></a>
<br>
Argilla
<br>
</h1>


Argilla is a **collaboration tool for AI engineers and domain experts** that require **high-quality outputs, data ownership, and overall efficiency**.

## Why use Argilla?

Whether you are working on monitoring and improving complex **generative tasks** involving LLM pipelines with RAG, or you are working on a **predictive task** for things like AB-testing of span- and text-classification models. Our versatile platform helps you ensure **your data work pays off**.


### Environment variables

Besides the common environment variables defined in docs, this Docker image provides a set of variables to simplify the server startup:
:

- `USERNAME`: If provided, the owner username. This can be combined with HF OAuth to define the argilla server owner (Default: `""`).

- `PASSWORD`: If provided, the owner password. If `USERNAME` and `PASSWORD` are provided, the owner user will be created with these credentials on the server startup (Default: `""`).

- `API_KEY`: If provided, the owner api key. When `USERNAME` and `PASSWORD` are provided and `API_KEY` is empty, a new random value will be generated (Default: `""`).

- `REINDEX_DATASET`: If `true` or `1`, the datasets will be reindexed in the search engine. This is needed when some search configuration changed or data must be refreshed (Default: `0`).

0 comments on commit 9feb7b1

Please sign in to comment.