Skip to content

Commit

Permalink
Merge branch 'main' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
jfcalvo committed Jul 30, 2024
2 parents 8b787a4 + c23126f commit c6aa0c0
Show file tree
Hide file tree
Showing 103 changed files with 1,000 additions and 679 deletions.
43 changes: 23 additions & 20 deletions .github/workflows/argilla-server.build-docker-images.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,19 @@ jobs:
echo "HF_SPACES_DOCKER_IMAGE=argilla/argilla-hf-spaces" >> $GITHUB_ENV
echo "DOCKER_USERNAME=$DOCKER_USERNAME" >> $GITHUB_ENV
echo "DOCKER_PASSWORD=$DOCKER_PASSWORD" >> $GITHUB_ENV
echo "PUBLISH_LATEST=$PUBLISH_LATEST" >> $GITHUB_ENV
else
echo "PLATFORMS=linux/amd64" >> $GITHUB_ENV
echo "IMAGE_TAG=$DOCKER_IMAGE_TAG" >> $GITHUB_ENV
echo "SERVER_DOCKER_IMAGE=argilladev/argilla-server" >> $GITHUB_ENV
echo "HF_SPACES_DOCKER_IMAGE=argilladev/argilla-hf-spaces" >> $GITHUB_ENV
echo "DOCKER_USERNAME=$DOCKER_USERNAME_DEV" >> $GITHUB_ENV
echo "DOCKER_PASSWORD=$DOCKER_PASSWORD_DEV" >> $GITHUB_ENV
echo "PUBLISH_LATEST=true" >> $GITHUB_ENV
fi
env:
IS_RELEASE: ${{ inputs.is_release }}
PUBLISH_LATEST: ${{ inputs.publish_latest }}
PACKAGE_VERSION: ${{ steps.package-info.outputs.PACKAGE_VERSION }}
DOCKER_IMAGE_TAG: ${{ steps.docker-image-tag-from-ref.outputs.docker-image-tag }}
DOCKER_USERNAME: ${{ secrets.AR_DOCKER_USERNAME }}
Expand Down Expand Up @@ -98,7 +101,7 @@ jobs:
push: true

- name: Push latest `argilla-server` image
if: ${{ inputs.is_release && inputs.publish_latest }}
if: ${{ env.PUBLISH_LATEST == 'true' }}
uses: docker/build-push-action@v5
with:
context: argilla-server/docker/server
Expand All @@ -120,7 +123,7 @@ jobs:
push: true

- name: Push latest `argilla-hf-spaces` image
if: ${{ inputs.is_release && inputs.publish_latest }}
if: ${{ env.PUBLISH_LATEST == 'true' }}
uses: docker/build-push-action@v5
with:
context: argilla-server/docker/argilla-hf-spaces
Expand All @@ -131,21 +134,21 @@ jobs:
ARGILLA_SERVER_IMAGE=${{ env.SERVER_DOCKER_IMAGE }}
ARGILLA_VERSION=${{ env.IMAGE_TAG }}
push: true

- name: Docker Hub Description for `argilla-server`
uses: peter-evans/dockerhub-description@v4
if: ${{ inputs.is_release && inputs.publish_latest }}
with:
username: ${{ env.DOCKER_USERNAME }}
password: ${{ env.DOCKER_PASSWORD }}
repository: $${{ env.SERVER_DOCKER_IMAGE }}
readme-filepath: argilla-server/README.md

- name: Docker Hub Description for `argilla-hf-spaces`
uses: peter-evans/dockerhub-description@v4
if: ${{ inputs.is_release && inputs.publish_latest }}
with:
username: ${{ secrets.AR_DOCKER_USERNAME }}
password: ${{ secrets.AR_DOCKER_PASSWORD }}
repository: $${{ env.HF_SPACES_DOCKER_IMAGE }}
readme-filepath: argilla-server/docker/argilla-hf-spaces/README.md
# TODO: uncomment this once the step works again
# - name: Docker Hub Description for `argilla-server`
# uses: peter-evans/dockerhub-description@v4
# if: ${{ env.PUBLISH_LATEST == 'true' }}
# with:
# username: ${{ env.DOCKER_USERNAME }}
# password: ${{ env.DOCKER_PASSWORD }}
# repository: $${{ env.SERVER_DOCKER_IMAGE }}
# readme-filepath: argilla-server/docker/server/README.md
# TODO: uncomment this once the step works again
# - name: Docker Hub Description for `argilla-hf-spaces`
# uses: peter-evans/dockerhub-description@v4
# if: ${{ env.PUBLISH_LATEST == 'true' }}
# with:
# username: ${{ env.DOCKER_USERNAME }}
# password: ${{ env.DOCKER_PASSWORD }}
# repository: $${{ env.HF_SPACES_DOCKER_IMAGE }}
# readme-filepath: argilla-server/docker/argilla-hf-spaces/README.md
2 changes: 1 addition & 1 deletion .github/workflows/argilla-server.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ jobs:
- build
with:
is_release: ${{ github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' }}
publish_latest: false
publish_latest: ${{ github.ref == 'refs/heads/main' }}
secrets: inherit

# This job will publish argilla-server python package into PyPI repository
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/argilla.docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ jobs:
if: startsWith(github.ref, 'refs/heads/docs') || startsWith(github.head_ref, 'docs/')
with:
message: |
Docs for this PR have been deployed hidden from versioning: [https://argilla-io.github.io/argilla/${{ steps.extract_branch_name.outputs.branch_name }}](https://argilla-io.github.io/argilla/${{ steps.extract_branch_name.outputs.branch_name }})
Docs for this PR have been deployed hidden from versioning: [https://docs.argilla.io/${{ steps.extract_branch_name.outputs.branch_name }}](https://docs.argilla.io/${{ steps.extract_branch_name.outputs.branch_name }})
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ We understand that getting started might be a bit difficult, therefore, you can

## Want to work on your own?

For more seasoned contributors, we recommend taking a look at the [contributor section](https://docs.argilla.io/en/latest/community/contributing.html) in our docs.
For more seasoned contributors, we recommend taking a look at the [contributor section](https://docs.argilla.io/latest/community/contributor/) in our docs.

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

Argilla is a collaboration tool for AI engineers and domain experts who need to build high-quality datasets for their projects.

If you just want to get started, we recommend our [UI demo](https://demo.argilla.io/sign-in?auth=ZGVtbzoxMjM0NTY3OA%3D%3D) or our [free Hugging Face Spaces deployment integration](https://huggingface.co/new-space?template=argilla/argilla-template-space). Curious, and want to know more? Read our [documentation](https://argilla-io.github.io/argilla/latest/).
If you just want to get started, [deploy Argilla on Hugging Face Spaces](https://docs.v2.argilla.io/latest/getting_started/quickstart/). Curious, and want to know more? Read our [documentation](https://docs.v2.argilla.io/latest/).

## Why use Argilla?

Expand Down Expand Up @@ -143,11 +143,11 @@ dataset.records.log(records=data, mapping={"text": "review"})
```

🎉 You have successfully created your first dataset with Argilla. You can now access it in the Argilla UI and start annotating the records.
Need more info, check out [our docs](https://argilla-io.github.io/argilla/latest/).
Need more info, check out [our docs](https://docs.argilla.io/latest/).

## 🥇 Contributors

To help our community with the creation of contributions, we have created our [community](https://argilla-io.github.io/argilla/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.
To help our community with the creation of contributions, we have created our [community](https://docs.argilla.io/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.

<a href="https://github.com/argilla-io/argilla/graphs/contributors">

Expand Down
7 changes: 4 additions & 3 deletions argilla-frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,11 @@
</p>

Argilla is a collaboration tool for AI engineers and domain experts who need to build high-quality datasets for their projects.
If you just want to get started, we recommend our [UI demo](https://demo.argilla.io/sign-in?auth=ZGVtbzoxMjM0NTY3OA%3D%3D) or our [free Hugging Face Spaces deployment integration](https://huggingface.co/new-space?template=argilla/argilla-template-space). Curious, and want to know more? Read our [documentation](https://argilla-io.github.io/argilla/latest/).

If you just want to get started, deploy Argilla with [Hugging Face Spaces](https://docs.v2.argilla.io/latest/getting_started/quickstart/). Curious, and want to know more? Read our [documentation](https://docs.v2.argilla.io).

This repository only contains developer info about the front end. If you want to get started, we recommend taking a
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://argilla-io.github.io/argilla/latest/).
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://docs.argilla.io/latest/).

Are you a contributor or do you want to understand what is going on under the hood, please keep reading the
documentation below.
Expand Down Expand Up @@ -76,7 +77,7 @@ npm run generate

## 🫱🏾‍🫲🏼 Contribute

To help our community with the creation of contributions, we have created our [community](https://argilla-io.github.io/argilla/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.
To help our community with the creation of contributions, we have created our [community](https://docs.argilla.io/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.

<a href="https://github.com/argilla-io/argilla/graphs/contributors">

Expand Down
11 changes: 5 additions & 6 deletions argilla-frontend/docs/snippets/start_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Welcome to

## Argilla is a platform for building high-quality AI datasets
## Argilla is a collaboration tool for building high-quality AI datasets

If you need support join the [Argilla Discord community](http://hf.co/join/discord)

Expand Down Expand Up @@ -30,16 +30,15 @@ import argilla as rg
client = rg.Argilla(
[local_]api_url="[LOCAL_HOST]",
[hf_]api_url="https://[HF_OWNER]-[HF_SPACE_NAME].hf.space",
api_key="[USER_API_KEY]",
[hf_]headers={"Authorization": f"Bearer {HF_TOKEN}"}
api_key="[USER_API_KEY]"
)
```

### 3. Create your first dataset

Specify a workspace where the dataset will be created. Check your workspaces in ["My settings"](/user-settings). To create a new workspace, check the [docs](https://argilla-io.github.io/argilla/latest/how_to_guides/workspace/).
Specify a workspace where the dataset will be created. Check your workspaces in ["My settings"](/user-settings). To create a new workspace, check the [docs](https://docs.argilla.io/latest/how_to_guides/workspace/).

Here, we are defining a creating a dataset with a text field and a label question ("positive" and "negative"), check the docs to [create a fully custom dataset](https://argilla-io.github.io/argilla/latest/how_to_guides/dataset/). Don't forget to replace "<your-workspace>".
Here, we are defining a creating a dataset with a text field and a label question ("positive" and "negative"), check the docs to [create a fully custom dataset](https://docs.argilla.io/latest/how_to_guides/dataset/). Don't forget to replace "<your-workspace>".

```python
settings = rg.Settings(
Expand Down Expand Up @@ -72,7 +71,7 @@ dataset.create()

You can create a list with records that you want to add. Ensure that you match the fields with those specified in the question settings.

You can also use `pandas` or `datasets.load_dataset` to [read an existing dataset and create records from it](https://argilla-io.github.io/argilla/latest/how_to_guides/record/).
You can also use `pandas` or `datasets.load_dataset` to [read an existing dataset and create records from it](https://docs.argilla.io/latest/how_to_guides/record/).

```python
records = [
Expand Down
10 changes: 2 additions & 8 deletions argilla-frontend/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
* limitations under the License.
*/

import { NuxtConfig } from "@nuxt/types";
import Mode from "frontmatter-markdown-loader/mode";
import { NuxtConfig } from "@nuxt/types";
import pkg from "./package.json";

const LOCAL_ENVIRONMENT = "http://0.0.0.0:6900";
Expand Down Expand Up @@ -204,14 +204,8 @@ const config: NuxtConfig = {
publicRuntimeConfig: {
clientVersion: pkg.version,
documentationSite: "https://docs.argilla.io/",
documentationSiteSemanticSearch:
"https://docs.argilla.io/en/latest/reference/webapp/features.html#semantic-search",
documentationSiteLabelScheme:
"https://docs.argilla.io/en/latest/guides/log_load_and_prepare_data.html#define-a-labeling-schema",
documentationSiteQueryDatasets:
"https://docs.argilla.io/en/latest/guides/query_datasets.html",
documentationPersistentStorage:
"https://docs.argilla.io/en/latest/getting_started/installation/deployments/huggingface-spaces.html#setting-up-persistent-storage",
"https://docs.argilla.io/latest/getting_started/how-to-configure-argilla-on-huggingface/#persistent-storage",
},
};
export default config;
10 changes: 6 additions & 4 deletions argilla-server/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ These are the section headers that we use:

## [Unreleased]()

## [2.0.0](https://github.com/argilla-io/argilla/compare/v2.0.0rc1...v2.0.0)

> [!IMPORTANT]
> This version includes changes related to the search index. So, a reindex is needed.
Expand Down Expand Up @@ -150,7 +152,7 @@ These are the section headers that we use:

> [!IMPORTANT]
> This version include changes related to the search index. So, a reindex is needed.
> Visit the [docs](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets) for more info.
> Visit the [docs](https://docs.v1.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets) for more info.
### Added

Expand All @@ -161,8 +163,8 @@ These are the section headers that we use:

### Changed

- Changed indexing responses for search to use user `id` instead of `username`. **[Reindex needed](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets)** ([#26](https://github.com/argilla-io/argilla-server/pull/26))
- Changed search index mappings definition to optimize the number of fields. **[Reindex needed](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets)** ([#31](https://github.com/argilla-io/argilla-server/pull/31))
- Changed indexing responses for search to use user `id` instead of `username`. **[Reindex needed](https://docs.v1.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets)** ([#26](https://github.com/argilla-io/argilla-server/pull/26))
- Changed search index mappings definition to optimize the number of fields. **[Reindex needed](https://docs.v1.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets)** ([#31](https://github.com/argilla-io/argilla-server/pull/31))

### Removed

Expand Down Expand Up @@ -649,7 +651,7 @@ These are the section headers that we use:
- Added Telemetry support for `ArgillaTrainer` (closes [#3325](https://github.com/argilla-io/argilla/issues/3325))
- `User.workspaces` is no longer an attribute but a property, and is calling `list_user_workspaces` to list all the workspace names for a given user ID ([#3334](https://github.com/argilla-io/argilla/pull/3334))
- Renamed `FeedbackDatasetConfig` to `DatasetConfig` and export/import from YAML as default instead of JSON (just used internally on `push_to_huggingface` and `from_huggingface` methods of `FeedbackDataset`) ([#3326](https://github.com/argilla-io/argilla/pull/3326)).
- The protected metadata fields support other than textual info - existing datasets must be reindex. See [docs](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#elasticsearch) for more detail (Closes [#3332](https://github.com/argilla-io/argilla/issues/3332)).
- The protected metadata fields support other than textual info - existing datasets must be reindex. See [docs](https://docs.v1.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#elasticsearch) for more detail (Closes [#3332](https://github.com/argilla-io/argilla/issues/3332)).
- Updated `Dockerfile` parent image from `python:3.9.16-slim` to `python:3.10.12-slim` ([#3425](https://github.com/argilla-io/argilla/pull/3425)).
- Updated `quickstart.Dockerfile` parent image from `elasticsearch:8.5.3` to `argilla/argilla-server:${ARGILLA_VERSION}` ([#3425](https://github.com/argilla-io/argilla/pull/3425)).

Expand Down
4 changes: 2 additions & 2 deletions argilla-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
Argilla is a collaboration tool for AI engineers and domain experts who need to build high-quality datasets for their projects.

This repository only contains developer info about the backend server. If you want to get started, we recommend taking a
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://argilla-io.github.io/argilla/latest/).
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://docs.argilla.io/latest/).

Are you a contributor or do you want to understand what is going on under the hood, please keep reading the
documentation below.
Expand Down Expand Up @@ -273,7 +273,7 @@ The `argilla_server search-engine` group of commands offers functionality to wor

## 🫱🏾‍🫲🏼 Contribute

To help our community with the creation of contributions, we have created our [community](https://argilla-io.github.io/argilla/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.
To help our community with the creation of contributions, we have created our [community](https://docs.argilla.io/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.

<a href="https://github.com/argilla-io/argilla/graphs/contributors">

Expand Down
2 changes: 1 addition & 1 deletion argilla-server/docker/argilla-hf-spaces/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ RUN \
apt-get update && apt-get install -y elasticsearch=8.8.2 && \
chown -R argilla:argilla /usr/share/elasticsearch /etc/elasticsearch /var/lib/elasticsearch /var/log/elasticsearch && \
chown argilla:argilla /etc/default/elasticsearch && \
# Install quickstart image dependencies
# Install image dependencies
pip install -r /packages/requirements.txt && \
chmod +x /home/argilla/start.sh && \
chmod +x /home/argilla/start_argilla_server.sh && \
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`).

Loading

0 comments on commit c6aa0c0

Please sign in to comment.