Merge branch 'fix/ingest-records-with-mapped-fields' into docs/end-to…

…-end-tutorial
argilla-io · Apr 11, 2024 · e92d008 · e92d008
2 parents a2a23d1 + 6007a53
commit e92d008
Show file tree

Hide file tree

Showing 56 changed files with 4,457 additions and 84 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -11,40 +11,31 @@ on:
 jobs:
   publish:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
     steps:
       - name: checkout docs-site
         uses: actions/checkout@v4
         with:
           ref: gh-pages
-
       - uses: actions/checkout@v4
-
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: pdm-project/setup-pdm@v3
         with:
           python-version: ${{ matrix.python-version }}
-          # Looks like it's not working very well for other people:
-          # https://github.com/actions/setup-python/issues/436
-          # cache: "pip"
-          # cache-dependency-path: pyproject.toml
-
-      - uses: actions/cache@v3
-        id: cache
-        with:
-          path: ${{ env.pythonLocation }}
-          key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-docs
-
+          cache: true
+          cache-dependency-path: |
+            pyproject.toml
       - name: Install dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
-        run: pdm install
-
+        run: |
+          pdm install
       - name: Set git credentials
         run: |
           git config --global user.name "${{ github.actor }}"
           git config --global user.email "${{ github.actor }}@users.noreply.github.com"
-
-      - run: mike deploy dev --push
+      - run: pdm run mike deploy dev --push
         if: github.ref == 'refs/heads/main'
-
-      - run: mike deploy ${{ github.ref_name }} latest --update-aliases --push
+      - run: pdm run mike deploy ${{ github.ref_name }} latest --update-aliases --push
         if: startsWith(github.ref, 'refs/tags/')
diff --git a/docs/CNAME b/docs/CNAME
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
diff --git a/docs/assets/logo-dark-mode.svg b/docs/assets/logo-dark-mode.svg
diff --git a/docs/assets/logo-light-mode.svg b/docs/assets/logo-light-mode.svg
diff --git a/docs/assets/og-doc.png b/docs/assets/og-doc.png
diff --git a/docs/how_to_guides/dataset/fields.md b/docs/how_to_guides/dataset/fields.md
@@ -0,0 +1 @@
+# Fields
diff --git a/docs/how_to_guides/dataset/index.md b/docs/how_to_guides/dataset/index.md
@@ -0,0 +1,3 @@
+# Dataset
+
+test
diff --git a/docs/how_to_guides/dataset/metadata.md b/docs/how_to_guides/dataset/metadata.md
@@ -0,0 +1 @@
+# Metadata
diff --git a/docs/how_to_guides/dataset/questions.md b/docs/how_to_guides/dataset/questions.md
@@ -0,0 +1 @@
+# Questions
diff --git a/docs/how_to_guides/dataset/vectors.md b/docs/how_to_guides/dataset/vectors.md
@@ -0,0 +1 @@
+# Vectors
diff --git a/docs/how_to_guides/fine_tune.md b/docs/how_to_guides/fine_tune.md
@@ -0,0 +1,8 @@
+---
+description: Argilla-python is the reference argilla python server SDK.
+---
+
+# Fine-tune
+
+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.
+
diff --git a/docs/how_to_guides/index.md b/docs/how_to_guides/index.md
@@ -0,0 +1,67 @@
+---
+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.
+---
+
+# How to guides
+
+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>
+
+-   :material-clock-fast:{ .lg .middle } __Manage your annotation team__
+
+    ---
+
+    Learn how to Create, Read, Update and Delete (CRUD) a [`Workspace`](#) or [`User`](#) in Argilla.
+
+    [:octicons-arrow-right-24: Getting started](/argilla-python/quickstart/)
+
+-   :material-clipboard-flow-outline:{ .lg .middle } __Define and change your dataset settings__
+
+    ---
+
+    Learn how to Create, Read, Update and Delete (CRUD) the [`Settings`](#) for a [`Dataset`](#), which are made up of settings for [`Fields`](#),[`Questions`](#),  [`Metadata`](#) and [`Vectors`](#).
+
+    [:octicons-arrow-right-24: Reference](#)
+
+-   :material-format-font:{ .lg .middle } __Work with records in your dataset__
+
+    ---
+
+    Learn how to Create, Read, Update and Delete (CRUD) the values for a[`Record`](#), which are made up of [`Suggestions`](#),[`Responses`](#),  [`Metadata`](#) and [`Vectors`](#).
+
+    [:octicons-arrow-right-24: Customization](#)
+
+-   :material-scale-balance:{ .lg .middle } __Query, filter and export data__
+
+    ---
+
+    Learn how to apply export [`Records`](#) with the right filters and queries.
+
+    [:octicons-arrow-right-24: License](#)
+
+-   :material-scale-balance:{ .lg .middle } __Distribute annotation work__
+
+    ---
+
+    Learn how to distribute [`Records`](#) to [`Users`](#) and [`Workspaces`](#) for managing annotation efforts the way you require.
+
+    [: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](#)
+
+</div>
diff --git a/docs/how_to_guides/metrics/annotator.md b/docs/how_to_guides/metrics/annotator.md
diff --git a/docs/how_to_guides/metrics/dataset.md b/docs/how_to_guides/metrics/dataset.md
diff --git a/docs/how_to_guides/metrics/model.md b/docs/how_to_guides/metrics/model.md
diff --git a/docs/how_to_guides/record/fields.md b/docs/how_to_guides/record/fields.md
diff --git a/docs/how_to_guides/record/index.md b/docs/how_to_guides/record/index.md
diff --git a/docs/how_to_guides/record/metadata.md b/docs/how_to_guides/record/metadata.md
@@ -0,0 +1 @@
+# Metadata
diff --git a/docs/how_to_guides/record/questions.md b/docs/how_to_guides/record/questions.md
diff --git a/docs/how_to_guides/record/vectors.md b/docs/how_to_guides/record/vectors.md
@@ -0,0 +1 @@
+# Vectors
diff --git a/docs/how_to_guides/team/index.md b/docs/how_to_guides/team/index.md
diff --git a/docs/how_to_guides/team/user.md b/docs/how_to_guides/team/user.md
@@ -0,0 +1,4 @@
+# Users
+
+A user in Argilla is an authorized person who can access the UI and use the Python client and CLI in a running Argilla instance.
+
diff --git a/docs/how_to_guides/team/workspace.md b/docs/how_to_guides/team/workspace.md
@@ -0,0 +1,3 @@
+# Workspaces
+
+Placeholder text
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		# Users

		A user in Argilla is an authorized person who can access the UI and use the Python client and CLI in a running Argilla instance.