Skip to content

Commit

Permalink
Add grid with different sections
Browse files Browse the repository at this point in the history
  • Loading branch information
plaguss committed Dec 19, 2023
1 parent 850c3f4 commit dfd9952
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 26 deletions.
File renamed without changes
30 changes: 30 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<div class="grid cards" markdown>

- <p align="center"> [**Tutorials**](./learn/tutorials/)</p>

---

End to end project lessons.

- <p align="center"> [**User Guides**](./learn/user-guides/)</p>

---

Practical guides to achieve specific tasks with `distilabel`.

- <p align="center"> [**Concept Guides**](./technical-reference/llms.md)</p>

---

Understand the components and their interactions.

- <p align="center"> [**API Reference**](./reference/distilabel)</p>

---

Technical description of the classes and functions.

</div>
50 changes: 25 additions & 25 deletions docs/technical-reference/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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].

Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit dfd9952

Please sign in to comment.