Docs/final docs 1.x revision (#1796)

* docs: - removed rubrix from readme quickstart - removed rubrix from docs quickstart * removed Rubreix from quickstart example * docs: - added hover behavior * docs: - removed usage of rubrix from libraries example * docs: - updated .gitignore to include tasks - updated .css to improve hover behaviour * docs: - adde terminology page - updated demo video - updated github readme * docs: - added tiles for deepdives - added tiles for tutorials * docs: some enhancements * docs: remove discussion linkl * docs: test removing what is argilla to avoid duplicated navigation * docs: Update README links linkedin and twitter (#1797) * docs: fix quickstart comments * docs: add general message instead of wip * docs: redo partially mlops steps * [pre-commit.ci] pre-commit autoupdate (#1798) updates: - [github.com/psf/black: 22.8.0 → 22.10.0](psf/black@22.8.0...22.10.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * chore: set next dev version * docs: small bug fixes and initial new set-up for deepdives * docs: renamed text2text->textgeneration, added guides for MLOps, resolved small typo´s and bugs. * Create docker-compose.yaml * docs: remove duplicate index, add documentation on deepdives for steps and some techniques * docs: added additional techniques sections, added additional picture for filtering, replaced github names for argilla * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update README.md * docs: resolved miss-direction and old naming in README.md * docs: corrected for iframe * docs: change iframe for mp4 * docs: added black formatting to notebooks * docs: Link key features (#1805) (#1809) * docs: Link key features (#1805) Signed-off-by: Christopher Schröder <[email protected]> * corrected for typo Signed-off-by: Christopher Schröder <[email protected]> Co-authored-by: Christopher Schröder <[email protected]> Co-authored-by: David Berenstein <[email protected]> * docs: added final deepdives, simplified headers. * docs: corrected for mis-placed tutorial * docs: added office hour Argilla button * docs: updated calendly office hours setting * Revert "Merge branch 'develop' into 'docs/final-docs-1.x-revision'" This reverts commit 3407082, reversing changes made to 4835ab8. * Merge branch 'main' into 'docs/final-docs-1.x-revision' Signed-off-by: Christopher Schröder <[email protected]> Co-authored-by: david <[email protected]> Co-authored-by: dvsrepo <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Christopher Schröder <[email protected]> Co-authored-by: Christopher Schröder <[email protected]>
argilla-io · Nov 3, 2022 · e880100 · e880100
1 parent e073f78
commit e880100
Show file tree

Hide file tree

Showing 78 changed files with 16,212 additions and 1,239 deletions.
diff --git a/.gitignore b/.gitignore
@@ -136,5 +136,3 @@ package-lock.json
 
 # App generated files
 src/**/server/static/
-docs/_source/guides/tasks
-docs/_source/guides/libraries/.ipynb_checkpoints
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -9,7 +9,7 @@ services:
     environment:
       ARGILLA_ELASTICSEARCH: http://elasticsearch:9200
       # ARGILLA_LOCAL_AUTH_USERS_DB_FILE: /config/.users.yaml
-    # volumes:
+      # volumes:
       #- ${PWD}/.users.yaml:/config/.users.yaml
     networks:
       - argilla

diff --git a/docs/_source/_common/features_all.md b/docs/_source/_common/features_all.md
@@ -1,4 +1,17 @@
-- [Features](./features/features): Our custom features to make your life a lot easier.
-    - [Datasets](./features/datasets)
-    - [Metrics](./features/metrics)
-    - [Queries](./features/queries)
+## Features
+````{grid}  1 1 3 3
+:class-container: tuto-section-2
+```{grid-item-card} Datasets
+:link: ./features/datasets.html
+
+```
+```{grid-item-card} Metrics
+:link: ./features/metrics.html
+
+```
+```{grid-item-card} Queries
+:link: ./features/queries.html
+
+```
+````
+
diff --git a/docs/_source/_common/features_points.md b/docs/_source/_common/features_points.md
@@ -1,5 +1,17 @@
 Are you unsure about what these features entail, take a look at our [terminology](/getting_started/terminology) section.
 
-- [Datasets](./datasets)
-- [Metrics](./metrics)
-- [Queries](./queries)
+````{grid}  1 1 3 3
+:class-container: tuto-section-2
+```{grid-item-card} Datasets
+:link: ./datasets.html
+
+```
+```{grid-item-card} Metrics
+:link: ./metrics.html
+
+```
+```{grid-item-card} Queries
+:link: ./queries.html
+
+```
+````
diff --git a/docs/_source/_common/libraries_all.md b/docs/_source/_common/libraries_all.md
@@ -1 +1,8 @@
-- [Libraries](./libraries/libraries): your favorite NLP libraries.
+## Libraries
+````{grid} 1 1 1 1
+:class-container: tuto-section-2
+```{grid-item-card} Libraries
+:link: ./libraries/libraries.html
+
+```
+````
diff --git a/docs/_source/_common/next_steps.md b/docs/_source/_common/next_steps.md
@@ -1,7 +1,7 @@
 ## Community
 
-⭐ Argilla [Github repo](https://github.com/recognai/rubrix) to stay updated.
+🙋‍♀️ Join the Argilla community on [Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g) and get direct support from the community.
 
-📚 [Argilla documentation](https://docs.argilla.io) for more guides and tutorials.
 
-🙋‍♀️ Join the Argilla community! A good place to start is the [discussion forum](https://github.com/recognai/rubrix/discussions) or our [Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g).
+⭐ Argilla [Github repo](https://github.com/argilla-io/argilla) to stay updated about new releases and tutorials.
+
diff --git a/docs/_source/_common/steps_all.md b/docs/_source/_common/steps_all.md
@@ -1,5 +1,20 @@
-- [MLOps Steps](./steps/steps): The steps we cover for the MLOps cycle.
-    - [🏷 Labelling](./steps/1_labelling)
-    - [💪🏽 Training](./steps/2_training)
-    - [👨🏽‍💻 Deploying](./steps/3_deploying)
-    - [📊 Monitoring](./steps/4_monitoring)
+## MLOps Steps
+
+````{grid}  1 1 4 4
+:class-container: tuto-section-2
+```{grid-item-card} 🏷 Labelling
+:link: ./steps/1_labelling.html
+
+```
+```{grid-item-card} 💪🏽 Training
+:link: ./steps/2_training.html
+
+```
+```{grid-item-card} 👨🏽‍💻 Deploying
+:link: ./steps/3_deploying.html
+
+```
+```{grid-item-card} 📊 Monitoring
+:link: ./steps/4_monitoring.html
+```
+````
diff --git a/docs/_source/_common/steps_points.md b/docs/_source/_common/steps_points.md
@@ -1,6 +1,20 @@
 Are you unsure about what these MLOps Steps entail, take a look at our [terminology](/getting_started/terminology) section.
 
-- [🏷 Labelling](./1_labelling)
-- [💪🏽 Training](./2_training)
-- [👨🏽‍💻 Deploying](./3_deploying)
-- [📊 Monitoring](./4_monitoring)
+````{grid}  1 1 4 4
+:class-container: tuto-section-2
+```{grid-item-card} 🏷 Labelling
+:link: ./1_labelling.html
+
+```
+```{grid-item-card} 💪🏽 Training
+:link: ./2_training.html
+
+```
+```{grid-item-card} 👨🏽‍💻 Deploying
+:link: ./3_deploying.html
+
+```
+```{grid-item-card} 📊 Monitoring
+:link: ./4_monitoring.html
+```
+````
diff --git a/docs/_source/_common/tasks_all.md b/docs/_source/_common/tasks_all.md
@@ -1,4 +1,16 @@
-- [NLP Tasks](./tasks/tasks): The tasks that Argilla can handle.
-    - [📕📗 TextClassification](./tasks/text_classification)
-    - [🈴🈯️ TokenClassification](./tasks/token_classification)
-    - [👨🏽💬 TextGeneration](./tasks/text_generation)
+## NLP Tasks
+````{grid}  1 1 3 3
+:class-container: tuto-section-2
+```{grid-item-card} 📕📗 TextClassification
+:link: ./tasks//text_classification.html
+
+```
+```{grid-item-card} 🈴🈯️ TokenClassification
+:link: ./tasks//token_classification.html
+
+```
+```{grid-item-card} 👨🏽💬 TextGeneration
+:link: ./tasks//text_generation.html
+
+```
+````
diff --git a/docs/_source/_common/tasks_points.md b/docs/_source/_common/tasks_points.md
@@ -1,5 +1,18 @@
 Are you unsure about what these NLP Tasks entail, take a look at our [terminology](/getting_started/terminology) section.
 
-- [📕📗 TextClassification](./text_classification)
-- [🈴🈯️ TokenClassification](./token_classification)
-- [👨🏽💬 TextGeneration](./text_generation)
+
+````{grid} 1 1 3 3
+:class-container: tuto-section-2
+```{grid-item-card} 📕📗 TextClassification
+:link: ./text_classification.html
+
+```
+```{grid-item-card} 🈴🈯️ TokenClassification
+:link: ./token_classification.html
+
+```
+```{grid-item-card} 👨🏽💬 TextGeneration
+:link: ./text_generation.html
+
+```
+````
diff --git a/docs/_source/_common/techniques_all.md b/docs/_source/_common/techniques_all.md
@@ -1,5 +1,22 @@
-- [Techniques](./techniques/techniques): Simple or advanced techniques for a more data-centric approach to your NLP problems.
-    - [👨🏽‍🏫 Active Learning](./techniques/active_learning)
-    - [👮 Weak Supervision](./techniques/weak_supervision)
-    - [🔎 Explainability and bias](./techniques/explainability)
-    - [🔫 Few-shot classification](./techniques/few_shot)
+## Techniques
+````{grid} 1 1 3 3
+:class-container: tuto-section-2
+```{grid-item-card} 🍼 Basics
+:link: ./techniques/1_basics.html
+
+```
+```{grid-item-card} 👨🏽‍🏫 Active Learning
+:link: ./techniques/active_learning.html
+
+```
+```{grid-item-card} 👮 Weak Supervision
+:link: ./techniques/weak_supervision.html
+
+```
+```{grid-item-card} 🔎 Explainability and bias
+:link: ./techniques/explainability.html
+```
+```{grid-item-card} 🔫 Few-shot classification
+:link: ./techniques/few_shot.html
+```
+````
diff --git a/docs/_source/_common/techniques_points.md b/docs/_source/_common/techniques_points.md
@@ -1,6 +1,23 @@
 Are you unsure about what these techniques entail, take a look at our [terminology](/getting_started/terminology) section.
 
-- [👨🏽‍🏫 Active Learning](./active_learning)
-- [👮 Weak Supervision](./weak_supervision)
-- [🔎 Explainability and bias](./explainability)
-- [🔫 Few-shot classification](./few_shot)
+````{grid} 1 1 3 3
+:class-container: tuto-section-2
+```{grid-item-card} 🍼 Basics
+:link: ./1_basics.html
+
+```
+```{grid-item-card} 👨🏽‍🏫 Active Learning
+:link: ./active_learning.html
+
+```
+```{grid-item-card} 👮 Weak Supervision
+:link: ./weak_supervision.html
+
+```
+```{grid-item-card} 🔎 Explainability and bias
+:link: ./explainability.html
+```
+```{grid-item-card} 🔫 Few-shot classification
+:link: ./few_shot.html
+```
+````
diff --git a/docs/_source/_static/css/custom.css b/docs/_source/_static/css/custom.css
@@ -812,15 +812,14 @@ a .tuto-section-11 {
 
 /* Cards */
 .sd-card {
-  border-top: none;
-  border-left: none;
-  border-right: none;
-  box-shadow: none !important;
+  border-top: 1px solid var(--color-background-primary);
+  border-left: 1px solid var(--color-background-primary);
+  border-right: 1px solid var(--color-background-primary);
   border-top-left-radius: 5px;
   border-top-right-radius: 5px;
   border-bottom-left-radius: 0;
   border-bottom-right-radius: 0;
-  margin-bottom: 2em;
+  margin-bottom: 1.5em;
 }
 
 .sd-card:hover {
@@ -833,7 +832,7 @@ a .tuto-section-11 {
 
 .sd-card img {
   width: auto;
-  margin: 2rem auto auto auto;
+  margin: 2rem auto -1rem auto;
   border-radius: 5px;
   object-fit: cover;
   object-position: 100% 0;
@@ -870,8 +869,16 @@ a .tuto-section-11 {
 }
 
 .tuto-section-2 .sd-card {
-  border-color: var(--tuto-section-2);
+  border-bottom-color: var(--tuto-section-2);
   background: var(--tuto-section-2);
+  transition: all 0.2s ease-in;
+}
+
+.tuto-section-2 .sd-card-hover:hover {
+  background: #f7b598;
+  border-color: #f7b598;
+  transition: all 0.2s ease-in;
+  box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.6rem rgba(0, 0, 0, .1) !important;
 }
 
 .tuto-section-3 .sd-card {
@@ -919,11 +926,14 @@ a .tuto-section-11 {
   background: var(--tuto-section-11);
 }
 
+.sd-card img+.sd-card-body {
+  border-radius: 0
+}
+
 .sd-card-body {
-  padding-left: 0;
-  padding-right: 0;
   background: var(--color-background-primary);
-  margin-top: -1em;
+  border-top-right-radius: 5px;
+  border-top-left-radius: 5px;
 }
 
 .sd-card-body .sd-card-title {

diff --git a/docs/_source/_static/reference/test.drawio b/docs/_source/_static/reference/test.drawio
@@ -0,0 +1,65 @@
+<mxfile host="65bd71144e">
+    <diagram id="qSDN_Jdxk1-9vS5839MN" name="Page-1">
+        <mxGraphModel dx="1008" dy="993" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="583" pageHeight="413" math="0" shadow="0">
+            <root>
+                <mxCell id="0"/>
+                <mxCell id="1" parent="0"/>
+                <mxCell id="6" style="edgeStyle=orthogonalEdgeStyle;curved=1;html=1;fontFamily=inter;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3Dinter;fontSize=18;strokeColor=#F8C0A7;" parent="1" source="6g5qlOxeHb8Cri41P2cF-1" target="5" edge="1">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="18" value="&lt;font face=&quot;inter&quot; data-font-src=&quot;https://fonts.googleapis.com/css?family=inter&quot; style=&quot;font-size: 18px&quot; color=&quot;#b83b32&quot;&gt;Predict&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="6">
+                    <mxGeometry x="-0.0667" y="-2" relative="1" as="geometry">
+                        <mxPoint y="-2" as="offset"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="6g5qlOxeHb8Cri41P2cF-1" value="&lt;span style=&quot;background-color: rgb(255 , 103 , 95)&quot;&gt;&lt;font style=&quot;font-size: 18px&quot; color=&quot;#ffffff&quot; data-font-src=&quot;https://fonts.googleapis.com/css?family=inter&quot; face=&quot;inter&quot;&gt;ML Model&lt;/font&gt;&lt;/span&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#FF675F;fontColor=#333333;strokeColor=#B83B32;strokeWidth=1;" parent="1" vertex="1">
+                    <mxGeometry x="200" y="80" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="4" style="edgeStyle=orthogonalEdgeStyle;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;fontFamily=inter;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3Dinter;fontSize=18;strokeColor=#F8C0A7;curved=1;" parent="1" source="3" target="6g5qlOxeHb8Cri41P2cF-1" edge="1">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="19" value="&lt;font face=&quot;inter&quot; data-font-src=&quot;https://fonts.googleapis.com/css?family=inter&quot; style=&quot;font-size: 18px&quot; color=&quot;#b83b32&quot;&gt;Learn&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="4">
+                    <mxGeometry x="0.1059" y="-9" relative="1" as="geometry">
+                        <mxPoint x="16" y="-9" as="offset"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="3" value="&lt;font face=&quot;inter&quot; data-font-src=&quot;https://fonts.googleapis.com/css?family=inter&quot; style=&quot;font-size: 18px&quot; color=&quot;#ffffff&quot;&gt;Labelled&lt;br&gt;Data&lt;/font&gt;" style="shape=datastore;whiteSpace=wrap;html=1;fillColor=#FF675F;strokeColor=#B83B32;" parent="1" vertex="1">
+                    <mxGeometry x="40" y="160" width="80" height="80" as="geometry"/>
+                </mxCell>
+                <mxCell id="8" value="" style="edgeStyle=orthogonalEdgeStyle;curved=1;html=1;fontFamily=inter;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3Dinter;fontSize=18;strokeColor=#F8C0A7;" parent="1" source="5" target="7" edge="1">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="16" value="&lt;font face=&quot;inter&quot; data-font-src=&quot;https://fonts.googleapis.com/css?family=inter&quot; style=&quot;font-size: 18px&quot; color=&quot;#b83b32&quot;&gt;Filter&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="8">
+                    <mxGeometry x="-0.0545" y="-2" relative="1" as="geometry">
+                        <mxPoint as="offset"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="5" value="&lt;font style=&quot;font-size: 18px&quot; face=&quot;inter&quot; data-font-src=&quot;https://fonts.googleapis.com/css?family=inter&quot; color=&quot;#ffffff&quot;&gt;&lt;font data-font-src=&quot;https://fonts.googleapis.com/css?family=inter&quot; style=&quot;font-size: 18px&quot;&gt;Prediction&lt;br&gt;&lt;/font&gt;Data&lt;/font&gt;" style="shape=datastore;whiteSpace=wrap;html=1;fillColor=#FF675F;strokeColor=#B83B32;" parent="1" vertex="1">
+                    <mxGeometry x="440" y="70" width="80" height="80" as="geometry"/>
+                </mxCell>
+                <mxCell id="10" style="edgeStyle=orthogonalEdgeStyle;curved=1;html=1;fontFamily=inter;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3Dinter;fontSize=18;strokeColor=#F8C0A7;" parent="1" source="7" target="9" edge="1">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="17" value="&lt;font style=&quot;font-size: 18px&quot; color=&quot;#b83b32&quot; face=&quot;inter&quot; data-font-src=&quot;https://fonts.googleapis.com/css?family=inter&quot;&gt;Query&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="10">
+                    <mxGeometry x="-0.0286" y="2" relative="1" as="geometry">
+                        <mxPoint x="-2" y="-2" as="offset"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="7" value="&lt;font face=&quot;inter&quot; color=&quot;#ffffff&quot;&gt;&lt;span style=&quot;font-size: 18px&quot;&gt;Uncertain Data&lt;/span&gt;&lt;/font&gt;" style="shape=datastore;whiteSpace=wrap;html=1;fillColor=#FF675F;strokeColor=#B83B32;" parent="1" vertex="1">
+                    <mxGeometry x="440" y="260" width="80" height="80" as="geometry"/>
+                </mxCell>
+                <mxCell id="11" style="edgeStyle=orthogonalEdgeStyle;curved=1;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;fontFamily=inter;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3Dinter;fontSize=18;strokeColor=#F8C0A7;" parent="1" source="9" target="3" edge="1">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="14" value="&lt;font face=&quot;inter&quot; data-font-src=&quot;https://fonts.googleapis.com/css?family=inter&quot; style=&quot;font-size: 18px&quot; color=&quot;#b83b32&quot;&gt;Label&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];fontColor=#FFFFFF;" parent="11" vertex="1" connectable="0">
+                    <mxGeometry x="-0.285" y="-3" relative="1" as="geometry">
+                        <mxPoint x="-8" y="-7" as="offset"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="9" value="&lt;font color=&quot;#b83b32&quot;&gt;Oracles&lt;/font&gt;" style="sketch=0;pointerEvents=1;shadow=0;dashed=0;html=1;strokeColor=#B83B32;labelPosition=center;verticalLabelPosition=bottom;verticalAlign=top;outlineConnect=0;align=center;shape=mxgraph.office.users.users;fillColor=#FF675F;fontFamily=inter;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3Dinter;fontSize=18;" parent="1" vertex="1">
+                    <mxGeometry x="220" y="260" width="80" height="80" as="geometry"/>
+                </mxCell>
+            </root>
+        </mxGraphModel>
+    </diagram>
+</mxfile>
diff --git a/...ic/reference/webapp/explore-text2text.png → ...ference/webapp/explore-textgeneration.png b/...ic/reference/webapp/explore-text2text.png → ...ference/webapp/explore-textgeneration.png
diff --git a/docs/_source/_static/reference/webapp/features-filter-score.png b/docs/_source/_static/reference/webapp/features-filter-score.png
diff --git a/docs/_source/_static/reference/webapp/features-token-attribution.png b/docs/_source/_static/reference/webapp/features-token-attribution.png
diff --git a/docs/_source/_static/reference/webapp/technique-active-learning.png b/docs/_source/_static/reference/webapp/technique-active-learning.png