Skip to content

Commit

Permalink
docs: update phrasing
Browse files Browse the repository at this point in the history
  • Loading branch information
davidberenstein1957 committed Oct 11, 2024
1 parent cd2b606 commit 0163664
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
9 changes: 4 additions & 5 deletions argilla/docs/getting_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,11 @@ Argilla is a free, open-source, self-hosted tool. This means you need to deploy
pip install argilla
```

Next, we can use the `Argilla.deploy_on_spaces` method, which will create a Space in [the Hugging Face Hub](https://huggingface.co/). This method will do the following:
Next, we can use the `Argilla.deploy_on_spaces` method, which will create a Space in [the Hugging Face Hub](https://huggingface.co/). This method will automatically do the following:

- Deploy an Argilla Space on the Hugging Face Hub, which takes around 2-3 minutes.
- Set the `API_KEY` secret based on the `api_key` you provide. This key will be used to authenticate your requests to the Argilla API.
- Set the `USERNAME` and `PASSWORD` secrets based on the username of the Hugging Face token and the `api_key` you provide, respectively.
- Automatically return an authenticated Argilla client, which can directly be used to interact with your Argilla server.
- Deploy an Argilla Space on the Hugging Face Hub with [OAuth sign-in](#sign-in-into-the-argilla-ui) and a URL like `https://<your-username>-argilla.hf.space`, which takes around 2-3 minutes.
- Create a default workspace called `argilla` with an owner called `<your-username>` and an Argilla token set to `api_key`.
- Automatically return the authenticated Argilla client, which can directly be used to interact with your Argilla server.

```python
import argilla as rg
Expand Down
1 change: 0 additions & 1 deletion argilla/docs/reference/argilla/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import argilla as rg
client = rg.Argilla.deploy_on_spaces(api_key="12345678")
```


### Connecting to an Argilla server

To connect to an Argilla server, instantiate the `Argilla` class and pass the `api_url` of the server and the `api_key` to authenticate.
Expand Down

0 comments on commit 0163664

Please sign in to comment.