Skip to content

Commit

Permalink
docs: add note (#5078)
Browse files Browse the repository at this point in the history
# Pull Request Template
<!-- 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
- 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/)
  • Loading branch information
sdiazlor authored Jun 20, 2024
1 parent d5f1e23 commit 7270969
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 8 deletions.
2 changes: 2 additions & 0 deletions argilla/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 4 additions & 5 deletions argilla/docs/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions argilla/docs/getting_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions argilla/docs/tutorials/text_classification.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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`"
]
},
Expand Down

0 comments on commit 7270969

Please sign in to comment.