Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor and improve docs #134

Merged
merged 40 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
7078e81
chore: add requirement to run mkdocs serve
Nov 29, 2023
27847ee
docs: add draft for learning section
Nov 30, 2023
3006955
refactor: guides as a part of the learn section
Nov 30, 2023
81ddb99
chore: add support to render notebooks
plaguss Nov 30, 2023
b269caf
docs: copy tutorial from gabri
plaguss Nov 30, 2023
6045f13
docs: update learn section
plaguss Dec 1, 2023
8826315
docs: let navigable section and new api reference
plaguss Dec 1, 2023
c4ea466
docs: add small overview of api reference
plaguss Dec 1, 2023
4cde7ac
Merge branch 'main' into docs/update-docs
plaguss Dec 1, 2023
1703837
Merge branch 'main' into docs/update-docs
plaguss Dec 7, 2023
eb54298
Update docs/api/pipeline.md
plaguss Dec 7, 2023
fe76cfc
Merge branch 'docs/update-docs' of https://github.com/argilla-io/dist…
plaguss Dec 7, 2023
fd1dcd6
wip
plaguss Dec 7, 2023
d727cfb
docs: rewrite for the llm concept guides
plaguss Dec 7, 2023
f05cb5d
chore: renamed files
plaguss Dec 7, 2023
7510475
refactor: updated user-guides content
plaguss Dec 7, 2023
0b5baf5
chore: allow adding footnotes and docs layout
plaguss Dec 7, 2023
553617a
docs: initial version of concept guides for llms and tasks
plaguss Dec 11, 2023
fcc9a94
docs: initial version for pipeline and llms
plaguss Dec 12, 2023
49da487
refactor: move wrong tutorial and place banner
plaguss Dec 12, 2023
4c2c4ce
Merge branch 'main' into docs/update-docs
plaguss Dec 12, 2023
7fd9d8b
docs: apply suggestions from code review
plaguss Dec 14, 2023
1a0d142
Merge branch 'docs/update-docs' of https://github.com/argilla-io/dist…
plaguss Dec 14, 2023
43a04be
docs: add suggestions from code review and move code snippets to its …
plaguss Dec 14, 2023
f047950
Merge branch 'main' into docs/update-docs
plaguss Dec 14, 2023
046416a
docs: removed noqa and avoid checking the docs with ruff
plaguss Dec 15, 2023
1e2ad18
chore: add new alembig image
plaguss Dec 15, 2023
8089bd2
Merge branch 'main' of https://github.com/argilla-io/distilabel into …
plaguss Dec 18, 2023
2c82ea8
Remove commented line
plaguss Dec 19, 2023
e25a1b4
Update logo.svg new name
plaguss Dec 19, 2023
cce4335
Merge branch 'docs/update-docs' of https://github.com/argilla-io/dist…
plaguss Dec 19, 2023
eaf5db7
Rename to HuggingFace
plaguss Dec 19, 2023
b441c06
Rename to HuggingFace
plaguss Dec 19, 2023
9096994
Rename to HuggingFace
plaguss Dec 19, 2023
43fe493
Point doc reference to main branch
plaguss Dec 19, 2023
0e0bac5
Fixed reference
plaguss Dec 19, 2023
4b0ca60
Remove comment
plaguss Dec 19, 2023
850c3f4
Merge branch 'docs/update-docs' of https://github.com/argilla-io/dist…
plaguss Dec 19, 2023
dfd9952
Add grid with different sections
plaguss Dec 19, 2023
0b33704
Update colours
plaguss Dec 19, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# API reference

This is your place for the technical references of `distilabel`. Here you will find the different components of the library and how they interact with each other.
plaguss marked this conversation as resolved.
Show resolved Hide resolved

You can navigate through the different concepts to have an overview of what's available, or go directly to the specific part of the API in the Code Reference.
plaguss marked this conversation as resolved.
Show resolved Hide resolved
17 changes: 17 additions & 0 deletions docs/api/llms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# LLMs

Already familiar with the `LLM` component? Otherwise you can take a look at the [concepts](../concepts.md) and come back later.
plaguss marked this conversation as resolved.
Show resolved Hide resolved

The following LLMs are implemented:

- [LlammaCppLLM][distilabel.llm.llama_cpp.LlamaCppLLM]:

- [OpenAILLM][distilabel.llm.openai.OpenAILLM]:

- [vLLM][distilabel.llm.vllm.vLLM]:

- Huggingface LLMs

- [TransformersLLM][distilabel.llm.huggingface.transformers.TransformersLLM]:

- [InferenceEndpointsLLM][distilabel.llm.huggingface.inference_endpoints.InferenceEndpointsLLM]:
7 changes: 7 additions & 0 deletions docs/api/pipeline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Pipelines

Already familiar with the `Pipelin` component? Otherwise you can take a look at the [concepts](../concepts.md) and come back later.
plaguss marked this conversation as resolved.
Show resolved Hide resolved
plaguss marked this conversation as resolved.
Show resolved Hide resolved

- [Pipeline][distilabel.pipeline.Pipeline]

- [pipeline][distilabel.pipeline.pipeline]
23 changes: 23 additions & 0 deletions docs/api/tasks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Tasks

Already familiar with the `Task` component? Otherwise you can take a look at the [concepts](../concepts.md) and come back later.

## Text Generation

This tasks will allow us guiding the LLM to generate texts.

The following tasks are implemented:

- [Llama2TextGenerationTask][distilabel.tasks.text_generation.llama.Llama2TextGenerationTask]: Your go to choice to prompt your LLM for the Llama2 model.
plaguss marked this conversation as resolved.
Show resolved Hide resolved

- [OpenAITextGenerationTask][distilabel.tasks.text_generation.openai.OpenAITextGenerationTask]: The task for any chat-completion OpenAI model.

- [SelfInstructTask][distilabel.tasks.text_generation.self_instruct.SelfInstructTask]: A task following the Self-Instruct specification for building the prompts.
plaguss marked this conversation as resolved.
Show resolved Hide resolved

## Preference

- [JudgeLMTask][distilabel.tasks.preference.judgelm.JudgeLMTask]: What's this

- [UltraFeedbackTask][distilabel.tasks.preference.ultrafeedback.UltraFeedbackTask]: What's this

- [UltraJudgeTask][distilabel.tasks.preference.ultrajudge.UltraJudgeTask]: What's this
3 changes: 0 additions & 3 deletions docs/guides.md

This file was deleted.

5 changes: 5 additions & 0 deletions docs/learn/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Learn

This is the reference section to learn how to use the power that `distilabel` has to offer. Here you can find the tutorials and guides to learn how to use `distilabel`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For distilabel docs, I'd highly recommend a more sober, technical and concise style.


Consider this the entrypoint to become an expert AI Feedback dataset crafter.
plaguss marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 3 additions & 0 deletions docs/learn/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Tutorials

This section contains lessons that will guide you step by step to create different types of datasets with the help of `distilabel`.
plaguss marked this conversation as resolved.
Show resolved Hide resolved
Loading