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: improve quickstart #5234

Merged
merged 4 commits into from
Jul 17, 2024
Merged

Docs: improve quickstart #5234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2666d25
Improve index
dvsrepo Jul 16, 2024
fcb8839
Docs: improve quickstart
dvsrepo Jul 16, 2024
dc9c8b2
Update argilla/docs/getting_started/quickstart.md
dvsrepo Jul 16, 2024
2568153
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 16, 2024
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
6 changes: 5 additions & 1 deletion argilla/docs/getting_started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ 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).
* Remotely using a [HF Space](https://huggingface.co/new-space?template=argilla/argilla-template-space). Check out the [full guide](huggingface-spaces.md) for a more detailed configuration.

!!! 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.0rc2`.
Expand All @@ -31,6 +31,10 @@ If you have already deployed Argilla Server, you can skip this step. Otherwise,
docker run -d --name quickstart -p 6900:6900 argilla/argilla-quickstart:v2.0.0rc2
```

!!! tip "Default user credentials to log into the UI"

This type of deployment automatically sets up some default users for you. Check [this guide](../how-to-guides/user.md) to log in for the first time in the UI.

### Connect to the Argilla server

Get your `<api_url>`:
Expand Down
6 changes: 3 additions & 3 deletions argilla/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Argilla is a **collaboration platform for AI engineers and domain experts** that

[:octicons-arrow-right-24: Quickstart](getting_started/quickstart.md)

- __Educational guides__
- __How-to guides__

---

Get familiar with basic and complex workflows for Argilla. From managing `Users`, `Workspaces`. `Datasets` and `Records` to fine-tuning a model.
Get familiar with basic and complex workflows for Argilla. Learn how to managing `Users`, `Workspaces`, `Datasets`, and `Records` to set up your data annotation projects.

[:octicons-arrow-right-24: Learn more](how_to_guides/index.md)

Expand Down Expand Up @@ -70,4 +70,4 @@ AI teams from companies like [the Red Cross](https://510.global/), [Loris.ai](ht

- AI for good: [the Red Cross presentation](https://youtu.be/ZsCqrAhzkFU?feature=shared) showcases **how their experts and AI team collaborate** by classifying and redirecting requests from refugees of the Ukrainian crisis to streamline the support processes of the Red Cross.
- Customer support: during [the Loris meetup](https://youtu.be/jWrtgf2w4VU?feature=shared) they showed how their AI team uses unsupervised and few-shot contrastive learning to help them **quickly validate and gain labelled samples for a huge amount of multi-label classifiers**.
- Research studies: [the showcase from Prolific](https://youtu.be/ePDlhIxnuAs?feature=shared) announced their integration with our platform. They use it to actively **distribute data collection projects** among their annotating workforce. This allows them to quickly and **efficiently collect high-quality data** for their research studies.
- Research studies: [the showcase from Prolific](https://youtu.be/ePDlhIxnuAs?feature=shared) announced their integration with our platform. They use it to actively **distribute data collection projects** among their annotating workforce. This allows them to quickly and **efficiently collect high-quality data** for their research studies.
Loading