Skip to content

Commit

Permalink
Update README.md (#4646)
Browse files Browse the repository at this point in the history
Added the requirement of creating a workspace and adding users to said
workspace to the README.md.

**Type of change**

- [x] Documentation update
  • Loading branch information
stevengans authored Mar 19, 2024
1 parent 5d2bfd2 commit 54f2c1e
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,26 @@ After this, you can start using Argilla, so you can create a dataset and add rec
</p>
</details>

<details>
<summary><a href="https://docs.argilla.io/en/latest/getting_started/installation/configurations/workspace_management.html#create-a-new-workspace">Create workspace</a></summary>
<p>
Once you have connected to the server, we will create a workspace for datasets.

```python
workspace = rg.Workspace.create("new-workspace")
```

After this, you can assign users to the workspace, this will allow the datasets to appear in the UI for that user.

```python
users = [u for u in rg.User.list() if u.role == "annotator"]
for user in users:
workspace.add_user(user)
```

</p>
</details>

<details>
<summary><a href="https://docs.argilla.io/en/latest/practical_guides/create_update_dataset/create_dataset.html">Configure datasets</a></summary>
<p>
Expand Down

0 comments on commit 54f2c1e

Please sign in to comment.