Installation¶
Install the SDK with pip¶
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.
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 with Docker.
Connect to the Argilla server¶
Get your <api_url>
:
- If you are using HF Spaces, it should be constructed as follows:
https://[your-owner-name]-[your_space_name].hf.space
- If you are using Docker, it is the URL shown in your browser (by default
http://localhost:6900
)
Get your <api_key>
in My Settings
in the Argilla UI (by default owner.apikey).
Note
Make sure to replace <api_url>
and <api_key>
with your actual values. If you are using a private HF Space, you need to specify your HF_TOKEN
which can be found here.
import argilla as rg
client = rg.Argilla(
api_url="<api_url>",
api_key="<api_key>",
# extra_headers={"Authorization": f"Bearer {HF_TOKEN}"}
)
Developer documentation¶
If you want to contribute to the development of the SDK, you can follow the instructions below.
Installation¶
To install the development dependencies, run the following commands:
# Install pdm (https://github.com/pdm-project/pdm)
pip install pdm
# Install the package in editable mode
pip install -e .
# Install the development dependencies with pdm
pdm install --dev
Generating documentation¶
To generate the docs you will need to install the development dependencies, and run the following command to create the development server with mkdocs
:
You will find the built documentation in http://localhost:8000/argilla-python/
.