Skip to content

Commit

Permalink
docs: 4920 v1 docs add banner with link to the new docs post refactor (
Browse files Browse the repository at this point in the history
…#5008)

# Argilla Community Growers

Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged.

# Pull Request Templates

Please go the the `Preview` tab and select the appropriate sub-template:

* [🐞-bug](?expand=1&template=bug.md)
* [📚-documentation](?expand=1&template=docs.md)
* [🆕-features](?expand=1&template=features.md)

# Generic Pull Request Template

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context. List any dependencies that
are required for this change.

Closes #<issue_number>

**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Refactor (change restructuring the codebase without changing
functionality)
- [ ] Improvement (change adding some improvement to an existing
functionality)
- [ ] Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

- [ ] Test A
- [ ] Test B

**Checklist**

- [ ] I added relevant documentation
- [ ] follows the style guidelines of this project
- [ ] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
  • Loading branch information
davidberenstein1957 authored Jun 13, 2024
1 parent f6edbdf commit 90f1ef6
Show file tree
Hide file tree
Showing 8 changed files with 56 additions and 33 deletions.
26 changes: 5 additions & 21 deletions argilla/docs/how_to_guides/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
description: These are the how-to guides for the the Argilla Python SDK SDK. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
description: These are the how-to guides for the Argilla Python SDK. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
hide: toc
---

# How-to guides

These are the how-to guides for the *the Argilla Python SDK SDK*. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
These are the how-to guides for *the Argilla Python SDK*. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.

<div class="grid cards" markdown>

Expand Down Expand Up @@ -49,28 +49,12 @@ These are the how-to guides for the *the Argilla Python SDK SDK*. They provide s

[:octicons-arrow-right-24: How-to guide](query_export.md)

<!-- - :material-scale-balance:{ .lg .middle } __Distribute annotation work__
- __Migrate to Argilla V2__

---

Learn how to distribute [`Records`](#) to [`Users`](#) and [`Workspaces`](#) for managing annotation efforts the way you require.
Learn how to migrate your legacy datasets from Argilla 1.x to 2.x.

[:octicons-arrow-right-24: License](#)
- :material-scale-balance:{ .lg .middle } __Evaluate annotators and models with metrics and KPIs__
---
Learn how to evaluate [`Users`](#) and Models with [`Metrics`](#) and [`KPIs`](#) to ensure the quality of your data, models and annotations.
[:octicons-arrow-right-24: License](#)
- :material-scale-balance:{ .lg .middle } __Fine-tune a model__
---
Learn how to fine-tune your own model with [`transformers`](#) and take ownership of your data and models.
[:octicons-arrow-right-24: License](#) -->
[:octicons-arrow-right-24: How-to guide](migrate_from_legacy_datasets.md)

</div>
1 change: 1 addition & 0 deletions argilla/docs/how_to_guides/migrate_from_legacy_datasets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Migrate your legacy datasets to Argilla V2
9 changes: 9 additions & 0 deletions argilla/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ hide: navigation

Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.

!!! SUCCESS "Welcome to Argilla 2.x!"
To skip the introductions and go directly to installing and creating your first dataset, see [Quickstart](getting_started/quickstart/).

!!! DANGER "Looking for Argilla 1.x?"
Looking for documentation for Argilla 1.x? Visit the latest release [here](https://docs.argilla.io/en/latest/).

!!! NOTE "Migrate to Argilla 2.x"
Want to learn how to migrate from Argilla 1.x to 2.x? Take a look at our dedicated [Migration Guide](how_to_guides/migrate_from_legacy_datasets.md).

<div class="grid cards" markdown>

- __Get started in 5 minutes!__
Expand Down
4 changes: 3 additions & 1 deletion argilla/docs/scripts/gen_changelog.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@

DATA_PATH = "community/changelog.md"

GITHUB_ACCESS_TOKEN = os.environ["GH_ACCESS_TOKEN"] # public_repo and read:org scopes are required
GITHUB_ACCESS_TOKEN = os.getenv("GH_ACCESS_TOKEN") # public_repo and read:org scopes are required


def fetch_file_from_github(repository, changelog_path, branch, auth_token):
if auth_token is None:
return ""
headers = {"Authorization": f"Bearer {auth_token}", "Accept": "application/vnd.github.v3+json"}

owner, repo_name = repository.split("/")
Expand Down
19 changes: 18 additions & 1 deletion argilla/docs/scripts/gen_popular_issues.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,27 @@
REPOSITORY = "argilla-io/argilla"
DATA_PATH = "community/popular_issues.md"

GITHUB_ACCESS_TOKEN = os.environ["GH_ACCESS_TOKEN"] # public_repo and read:org scopes are required
GITHUB_ACCESS_TOKEN = os.getenv("GH_ACCESS_TOKEN") # public_repo and read:org scopes are required


def fetch_data_from_github(repository, auth_token):
if auth_token is None:
return pd.DataFrame(
{
"Issue": [],
"State": [],
"Created at": [],
"Closed at": [],
"Last update": [],
"Labels": [],
"Milestone": [],
"Reactions": [],
"Comments": [],
"URL": [],
"Repository": [],
"Author": [],
}
)
headers = {"Authorization": f"token {auth_token}", "Accept": "application/vnd.github.v3+json"}
issues_data = []

Expand Down
1 change: 1 addition & 0 deletions argilla/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ nav:
- Manage and create datasets: how_to_guides/dataset.md
- Add, update, and delete records: how_to_guides/record.md
- Query, filter, and export records: how_to_guides/query_export.md
- Migrate your legacy datasets to Argilla V2: how_to_guides/migrate_from_legacy_datasets.md
- API Reference:
- Python SDK: reference/argilla/
- Community:
Expand Down
23 changes: 13 additions & 10 deletions docs/_source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
version_ = rg.__version__
except ModuleNotFoundError:
version_ = os.environ.get("VERSION")

except AttributeError:
version_ = os.environ.get("VERSION")

project = "Argilla"
copyright = f"{datetime.today().year}, Argilla.io"
Expand Down Expand Up @@ -82,9 +83,8 @@
"pipversion": "" if "dev" in release else "==" + release,
"dockertag": "master" if "dev" in release else "v" + release,
}
myst_substitutions[
"dockercomposeyaml"
] = """```yaml
myst_substitutions["dockercomposeyaml"] = (
"""```yaml
# docker-compose.yaml
version: "3"
Expand All @@ -98,11 +98,11 @@
ARGILLA_AUTH_SECRET_KEY: Please generate a 32 character random string with: openssl rand -hex 32
restart: unless-stopped
```""".format(
myst_substitutions["dockertag"]
myst_substitutions["dockertag"]
)
)
myst_substitutions[
"dockercomposeuseryaml"
] = """```yaml
myst_substitutions["dockercomposeuseryaml"] = (
"""```yaml
# docker-compose.yaml
services:
argilla:
Expand All @@ -119,14 +119,17 @@
- ${}/.users.yaml:/config/.users.yaml
...
```""".format(
myst_substitutions["dockertag"], "PWD"
myst_substitutions["dockertag"], "PWD"
)
)

# Do not execute the notebooks when building the docs
nbsphinx_execute = "never"

# open html file as Python string
getting_started_html = open("./_common/getting_started.html", "r", encoding="utf8").read()
getting_started_html = open(
"./_common/getting_started.html", "r", encoding="utf8"
).read()
next_steps_html = open("./_common/next_steps.html", "r", encoding="utf8").read()

# -- AUTODOC IMPORT MOCKS ---------------------------------------------------
Expand Down
6 changes: 6 additions & 0 deletions docs/_source/getting_started/argilla.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

[Argilla](https://argilla.io) is an open-source data curation platform for LLMs. Using Argilla, everyone can build robust language models through faster data curation using both human and machine feedback. We provide support for each step in the MLOps cycle, from data labeling to model monitoring.

```{admonition} Argilla 2.x
:class: danger
We are announcing that Argilla 1.29 is the final minor release for Argilla 1.x. Although we will continue to release bug fixes for this version, we will neither be adding nor removing any functionalities. Instead, we will focus our efforts on Argilla 2.x. Argilla 1.29 will reach its end-of-life on June 20, 2025.
Looking for documentation for Argilla 2.x? Visit the docs [here](https://argilla-io.github.io/argilla/dev/)!
```

<div class="social social--sidebar" style="margin-top: 1em; display: flex; justify-content: right; gap: 8px">
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g"
class="button--primary" target="_blank">Join <span aria-label="slack" class="slack-icon"></span></a>
Expand Down

0 comments on commit 90f1ef6

Please sign in to comment.