Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add note #5078

Merged
merged 1 commit into from
Jun 20, 2024
Merged

docs: add note #5078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions argilla/README.md
View file
Open in desktop
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`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add the same note in the root README.md file?


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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading