From 727096982bad23403c80daf424a38d3421e83d44 Mon Sep 17 00:00:00 2001 From: Sara Han <127759186+sdiazlor@users.noreply.github.com> Date: Thu, 20 Jun 2024 17:25:16 +0200 Subject: [PATCH] docs: add note (#5078) # Pull Request Template Closes # **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** **Checklist** - I added relevant documentation - follows 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/) --- argilla/README.md | 2 ++ argilla/docs/getting_started/installation.md | 9 ++++----- argilla/docs/getting_started/quickstart.md | 7 ++++--- argilla/docs/tutorials/text_classification.ipynb | 4 ++++ 4 files changed, 14 insertions(+), 8 deletions(-) diff --git a/argilla/README.md b/argilla/README.md index 296b766c52..e9da0eaf1a 100644 --- a/argilla/README.md +++ b/argilla/README.md @@ -91,6 +91,8 @@ pip install argilla --pre After that, you will need to deploy Argilla Server. The easiest way to do this is through our [free Hugging Face Spaces deployment integration](https://huggingface.co/new-space?template=argilla/argilla-template-space). +> As this is a release candidate version, you'll need to manually change the version in the HF Space Files > Dockerfile to `argilla/argilla-quickstart:v2.0.0rc1`. + To use the client, you need to import the `Argilla` class and instantiate it with the API URL and API key. ```python diff --git a/argilla/docs/getting_started/installation.md b/argilla/docs/getting_started/installation.md index 1bcb5e527f..bd4056a33f 100644 --- a/argilla/docs/getting_started/installation.md +++ b/argilla/docs/getting_started/installation.md @@ -6,20 +6,19 @@ description: Installation of the Argilla SDK. ## Install the SDK with pip -Since this package is not yet published on PyPi, you can install it directly from the repository: - ```console -pip install git+https://github.com/argilla-io/argilla-python.git +pip install argilla --pre ``` ## Run the Argilla server If you have already deployed Argilla Server, you can skip this step. Otherwise, you can quickly deploy it in two different ways: +* Using a [HF Space](https://huggingface.co/new-space?template=argilla/argilla-template-space). + !!! note - You can use this SDK with any stable release of argilla server >= 1.27. + As this is a release candidate version, you'll need to manually change the version in the HF Space Files > Dockerfile to `argilla/argilla-quickstart:v2.0.0rc1`. -* Using a [HF Space](https://huggingface.co/new-space?template=argilla/argilla-template-space). * Locally with Docker. ```console diff --git a/argilla/docs/getting_started/quickstart.md b/argilla/docs/getting_started/quickstart.md index eacf47047c..d7fa361974 100644 --- a/argilla/docs/getting_started/quickstart.md +++ b/argilla/docs/getting_started/quickstart.md @@ -12,9 +12,6 @@ This guide provides a quick overview of the Argilla SDK and how to create your f To work with Argilla datasets, you need to use the Argilla SDK. You can install the SDK with pip as follows: -!!! note - The package is not yet available on PyPi. You'll need to install it directly from the GitHub repository. - ```console pip install argilla --pre ``` @@ -24,6 +21,10 @@ pip install argilla --pre If you have already deployed Argilla Server, you can skip this step. Otherwise, you can quickly deploy it in two different ways: * Remotely using a [HF Space](https://huggingface.co/new-space?template=argilla/argilla-template-space). + +!!! note + As this is a release candidate version, you'll need to manually change the version in the HF Space Files > Dockerfile to `argilla/argilla-quickstart:v2.0.0rc1`. + * Locally using Docker. ```console diff --git a/argilla/docs/tutorials/text_classification.ipynb b/argilla/docs/tutorials/text_classification.ipynb index 2cad83bab7..37acc89c1d 100644 --- a/argilla/docs/tutorials/text_classification.ipynb +++ b/argilla/docs/tutorials/text_classification.ipynb @@ -43,6 +43,10 @@ "If you have already deployed Argilla Server, you can skip this step. Otherwise, you can quickly deploy it in two different ways:\n", "\n", "* Remotely using a [HF Space](https://huggingface.co/new-space?template=argilla/argilla-template-space). ⚠️ If persistent storage is not enabled, you will lose your data when the server is stopped.\n", + "\n", + "!!! note\n", + " As this is a release candidate version, you'll need to manually change the version in the HF Space Files > Dockerfile to `argilla/argilla-quickstart:v2.0.0rc1`.\n", + "\n", "* Locally using Docker: `docker run -d --name quickstart -p 6900:6900 argilla/argilla-quickstart:v2.0.0rc1`" ] },