From dfd9952a152421adb31d7adfc0e29b5f491a3d3e Mon Sep 17 00:00:00 2001 From: plaguss Date: Tue, 19 Dec 2023 12:14:42 +0100 Subject: [PATCH] Add grid with different sections --- docs/assets/{alembic.svg => logo.svg} | 0 docs/index.md | 30 ++++++++++++++++ docs/technical-reference/tasks.md | 50 +++++++++++++-------------- pyproject.toml | 1 - 4 files changed, 55 insertions(+), 26 deletions(-) rename docs/assets/{alembic.svg => logo.svg} (100%) diff --git a/docs/assets/alembic.svg b/docs/assets/logo.svg similarity index 100% rename from docs/assets/alembic.svg rename to docs/assets/logo.svg diff --git a/docs/index.md b/docs/index.md index 6be6af1640..39e4ac5588 100644 --- a/docs/index.md +++ b/docs/index.md @@ -39,3 +39,33 @@ will create a `labeller` LLM using `OpenAILLM` with the `UltraFeedback` task for For a more complete example, check out our awesome notebook on Google Colab: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1rO1-OlLFPBC0KPuXQOeMpZOeajiwNoMy?usp=sharing) + +## Navigation + +
+ +-

[**Tutorials**](./learn/tutorials/)

+ + --- + + End to end project lessons. + +-

[**User Guides**](./learn/user-guides/)

+ + --- + + Practical guides to achieve specific tasks with `distilabel`. + +-

[**Concept Guides**](./technical-reference/llms.md)

+ + --- + + Understand the components and their interactions. + +-

[**API Reference**](./reference/distilabel)

+ + --- + + Technical description of the classes and functions. + +
\ No newline at end of file diff --git a/docs/technical-reference/tasks.md b/docs/technical-reference/tasks.md index 259809a652..d449cf3b72 100644 --- a/docs/technical-reference/tasks.md +++ b/docs/technical-reference/tasks.md @@ -88,45 +88,45 @@ The following snippet can be used as a simplified UltraFeedback Task, for which --8<-- "docs/snippets/technical-reference/tasks/ultrafeedback.py" ``` -- Text Quality: +=== "Text Quality" -The following example uses a `LLM` to examinate the data for text quality criteria, which includes the different criteria from UltraFeedback (Correctness & Informativeness, Honesty & Uncertainty, Truthfulness & Hallucination and Instruction Following): + The following example uses a `LLM` to examinate the data for text quality criteria, which includes the different criteria from UltraFeedback (Correctness & Informativeness, Honesty & Uncertainty, Truthfulness & Hallucination and Instruction Following): -```python ---8<-- "docs/snippets/technical-reference/tasks/openai_for_text_quality.py" -``` + ```python + --8<-- "docs/snippets/technical-reference/tasks/openai_for_text_quality.py" + ``` -- Helpfulness: +=== "Helpfulness" -The following example creates a UltraFeedback task to emphasize helpfulness, that is overall quality and correctness of the output: + The following example creates a UltraFeedback task to emphasize helpfulness, that is overall quality and correctness of the output: -```python ---8<-- "docs/snippets/technical-reference/tasks/openai_for_helpfulness.py" -``` + ```python + --8<-- "docs/snippets/technical-reference/tasks/openai_for_helpfulness.py" + ``` -- Truthfulness: +=== "Truthfulness" -The following example creates a UltraFeedback task to emphasize truthfulness and hallucination assessment: + The following example creates a UltraFeedback task to emphasize truthfulness and hallucination assessment: -```python ---8<-- "docs/snippets/technical-reference/tasks/openai_for_truthfulness.py" -``` + ```python + --8<-- "docs/snippets/technical-reference/tasks/openai_for_truthfulness.py" + ``` -- Honesty: +=== "Honesty" -The following example creates a UltraFeedback task to emphasize honesty and uncertainty expression assessment: + The following example creates a UltraFeedback task to emphasize honesty and uncertainty expression assessment: -```python ---8<-- "docs/snippets/technical-reference/tasks/openai_for_honesty.py" -``` + ```python + --8<-- "docs/snippets/technical-reference/tasks/openai_for_honesty.py" + ``` -- Instruction Following: +=== "Instruction Following" -The following example creates a UltraFeedback task to emphasize the evaluation of alignment between output and intent: + The following example creates a UltraFeedback task to emphasize the evaluation of alignment between output and intent: -```python ---8<-- "docs/snippets/technical-reference/tasks/openai_for_instruction_following.py" -``` + ```python + --8<-- "docs/snippets/technical-reference/tasks/openai_for_instruction_following.py" + ``` For the API reference visit [UltraFeedbackTask][distilabel.tasks.preference.ultrafeedback.UltraFeedbackTask]. diff --git a/pyproject.toml b/pyproject.toml index 0b4f775193..8cb60158ca 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,7 +44,6 @@ docs = [ "mkdocs-literate-nav >= 0.6.1", "mkdocs-section-index >= 0.3.8", "mkdocs-gen-files >= 0.5.0", - "mknotebooks >= 0.8.0", ] [project.urls]