-
Notifications
You must be signed in to change notification settings - Fork 66
/
mkdocs.yml
190 lines (180 loc) · 6.43 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# Project information
site_name: distilabel
site_url: https://argilla-io.github.io/distilabel
site_author: Argilla, Inc.
site_description: Distilabel is an AI Feedback (AIF) framework for building datasets with and for LLMs.
# Repository
repo_name: argilla-io/distilabel
repo_url: https://github.com/argilla-io/distilabel
extra:
version:
provider: mike
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
theme:
name: material
logo: assets/logo.svg
favicon: assets/logo.svg
icon:
repo: fontawesome/brands/github-alt
features:
- navigation.sections # Sections are included in the navigation on the left.
# - toc.integrate # # Table of contents is integrated on the left; does not appear separately on the right.
- header.autohide # header disappears as you scroll
- content.code.copy
- content.code.annotate
- content.tabs.link
palette:
- media: "(prefers-color-scheme)"
primary: white
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
toggle:
icon: material/brightness-4
name: Switch to system preference
watch:
- src/distilabel
# Extensions
markdown_extensions:
- attr_list
- md_in_html
- admonition
- pymdownx.superfences
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets:
check_paths: true
base_path: [examples/, docs/, "."]
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- footnotes
- toc:
permalink: true
plugins:
- search
- autorefs # Cross-links to headings
- gen-files:
scripts:
- docs/scripts/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
- mkdocstrings:
handlers:
python:
selection:
inherited_members: true # Allow looking up inherited methods
options:
show_protected_members: true
show_private_members: true
rendering:
show_root_heading: true # actually display anything at all...
# show_root_full_path: true # display "diffrax.asdf" not just "asdf"
show_if_no_docstring: true
show_signature_annotations: true
show_source: false # don't include source code
members_order: source # order methods according to their order of definition in the source code, not alphabetical order
heading_level: 4
- social
- distilabel/components-gallery:
add_after_page: Learn
nav:
- Introduction: "index.md"
- Getting started:
- Installation: "sections/installation.md"
- How-to-Guide: "sections/how_to_guide.md"
- Learn:
- "sections/learn/index.md"
- Tutorial:
- "sections/learn/tutorial/index.md"
- Step:
- "sections/learn/tutorial/step/index.md"
- GeneratorStep: "sections/learn/tutorial/step/generator_step.md"
- GlobalStep: "sections/learn/tutorial/step/global_step.md"
- Task:
- "sections/learn/tutorial/task/index.md"
- GeneratorTask: "sections/learn/tutorial/task/generator_task.md"
- LLM: "sections/learn/tutorial/llm/index.md"
- Pipeline: "sections/learn/tutorial/pipeline/index.md"
- CLI: "sections/learn/tutorial/cli/index.md"
- Advanced:
- "sections/learn/advanced/index.md"
- Argilla: "sections/learn/advanced/argilla.md"
- Caching: "sections/learn/advanced/caching.md"
- Distiset: "sections/learn/advanced/distiset.md"
- Structured Generation: "sections/learn/advanced/structured_generation.md"
- Pipeline Samples:
- "sections/pipeline_samples/index.md"
- Examples: "sections/pipeline_samples/examples/index.md"
- Papers:
- "sections/pipeline_samples/papers/index.md"
- DEITA: "sections/pipeline_samples/papers/deita.md"
- Instruction Backtranslation: "sections/pipeline_samples/papers/instruction_backtranslation.md"
# - Prometheus: "sections/examples/papers/prometheus.md"
- UltraFeedback: "sections/pipeline_samples/papers/ultrafeedback.md"
- FAQ: "sections/faq.md"
- API Reference:
- Pipeline:
- "api/pipeline/index.md"
- Routing Batch Function: "api/pipeline/routing_batch_function.md"
- Typing: "api/pipeline/typing.md"
- Utils: "api/pipeline/utils.md"
- Step:
- "api/step/index.md"
- GeneratorStep: "api/step/generator_step.md"
- GlobalStep: "api/step/global_step.md"
- "@step": "api/step/decorator.md"
- Step Gallery:
- Argilla: "api/step_gallery/argilla.md"
- Columns: "api/step_gallery/columns.md"
- Extra: "api/step_gallery/extra.md"
- Task:
- "api/task/index.md"
- GeneratorTask: "api/task/generator_task.md"
- Task Gallery: "api/task_gallery/index.md"
- LLM:
- "api/llm/index.md"
- LLM Gallery:
- Anthropic: "api/llm/anthropic.md"
- Anyscale: "api/llm/anyscale.md"
- Azure (via OpenAI): "api/llm/azure.md"
- Groq: "api/llm/groq.md"
- Hugging Face: "api/llm/huggingface.md"
- LiteLLM: "api/llm/litellm.md"
- llama.cpp: "api/llm/llamacpp.md"
- Mistral: "api/llm/mistral.md"
- Ollama: "api/llm/ollama.md"
- OpenAI: "api/llm/openai.md"
- Together AI: "api/llm/together.md"
- Google Vertex AI: "api/llm/vertexai.md"
- vLLM: "api/llm/vllm.md"
- CLI: "api/cli.md"