Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
210 lines (210 loc) · 9.06 KB
/
Copy pathmkdocs.yml
File metadata and controls
210 lines (210 loc) · 9.06 KB
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# Project Information
site_name: "ado Documentation"
site_url: "https://ibm.github.io/ado/"
site_description: "Documentation website for https://github.com/ibm/ado"
site_author: "The ado authors"
# Repository Information
repo_name: 'ibm/ado'
repo_url: 'https://github.com/ibm/ado'
edit_uri: 'edit/main/docs'
docs_dir: 'docs'
site_dir: 'site'
remote_branch: 'gh-pages'
remote_name: 'origin'
# Server info
dev_addr: '127.0.0.1:8000'
# Copyright
copyright: Copyright IBM Research.
# Extra links as icons at the bottom of the page
extra:
version:
provider: mike
default: latest
social:
- icon: fontawesome/brands/github
link: https://github.com/ibm/ado
- icon: fontawesome/solid/globe
link: https://www.ibm.com/
extra_css:
- https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,100..700;1,100..700&display=swap
- https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;1,100;1,200;1,300;1,400;1,500;1,600;1,700&family=IBM+Plex+Sans:ital,wght@0,100..700;1,100..700&display=swap
theme:
name: material
language: en
include_search_page: true
search_index_only: true
custom_dir: docs/theme
favicon: 'favicon.ico'
logo: 'logo-ibm.png'
font: false
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: black
accent: blue
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
accent: blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
primary: black
accent: blue
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- content.action.edit
- content.action.feedback
# # - content.action.view
- content.code.annotate # Attach arbitrary content to specific sections of code blocks by adding numeric markers
- content.code.copy # Button to allow the user to copy a code block's contents to the clipboard
- content.tabs.link
- navigation.footer # Links to previous and next page
- navigation.indexes # Attach documents to sections, useful for providing overview pages
- navigation.instant # Single page instant refresh
- navigation.sections # Top level tabs rendered in sidebar
- navigation.tabs # Navigation tabs across top. Comment this out to have navigation on the left
- navigation.tabs.sticky # Tab always displayed
- navigation.top # Back-to-top button. Rendered centered and just below the header
- navigation.tracking # URL updated with active anchor
- search.share
- search.suggest
# - toc.integrate # Integrate page TOC in left sidebar - wider page
icon:
edit: 'material/pencil-outline'
markdown_extensions:
admonition: {}
# def_list: {}
tables: {}
footnotes: {}
# attr_list and md_in_html are needed for the grid cards
attr_list: {}
md_in_html: {}
# Better emphasis handling: https://facelessuser.github.io/pymdown-extensions/extensions/betterem/
pymdownx.betterem: {}
# Sections that can be disclosed: https://facelessuser.github.io/pymdown-extensions/extensions/details/
pymdownx.details: {}
# Emojis via shortnames: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/
pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
# Better list support: https://facelessuser.github.io/pymdown-extensions/extensions/fancylists/
pymdownx.fancylists: {}
# Code syntax highlighting: https://facelessuser.github.io/pymdown-extensions/extensions/highlight/
pymdownx.highlight: {}
# Inline code highlighting: https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/
pymdownx.inlinehilite: {}
# Autolink: https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/
pymdownx.magiclink: {}
# Highlighter: https://facelessuser.github.io/pymdown-extensions/extensions/mark/
pymdownx.mark: {}
# Symbols: https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/
pymdownx.smartsymbols: {}
# Strip HTML: https://facelessuser.github.io/pymdown-extensions/extensions/striphtml/
pymdownx.striphtml: {}
# Better fencing: https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
pymdownx.superfences:
preserve_tabs: true
# Tabs: https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/
pymdownx.tabbed:
alternate_style: true
# Tasklists: https://facelessuser.github.io/pymdown-extensions/extensions/tasklist/
pymdownx.tasklist:
custom_checkbox: true
# Strikethrough: https://facelessuser.github.io/pymdown-extensions/extensions/tilde/
pymdownx.tilde: {}
pymdownx.progressbar: {}
pymdownx.arithmatex: {}
toc:
permalink: true
toc_depth: 4
# Recording sources for docs/videos, not publishable content
exclude_docs: |
videos/tapes/
plugins:
- search:
- mike:
- minify:
minify_html: true
minify_js: true
minify_css: true
- include-markdown:
- gh-admonitions:
nav:
- Home:
- Home: index.md
- Roadmap: roadmap.md
- User Guide:
- Getting Started: user-guide/getting-started.md
- ado and Agents: user-guide/ado-and-agents.md
- Resources:
- Working with resources: resources/working-with-resources.md
- The metastore: resources/metastore.md
- samplestore: resources/sample-stores.md
- discoveryspace: resources/discovery-spaces.md
- operation: resources/operation.md
- actuatorconfiguration: resources/actuatorconfig.md
- datacontainer: resources/datacontainer.md
- document: resources/document.md
- Actuators:
- Working with actuators: user-guide/actuators/working-with-actuators.md
- Actuator Guides:
- "The Replay Actuator: Using externally obtained data": user-guide/actuators/replay.md
- vllm_performance actuator: user-guide/actuators/vllm-performance.md
- SFTTrainer actuator: user-guide/actuators/sft-trainer.md
- Operators:
- Working with operators: user-guide/operators/working-with-operators.md
- Explore operators: user-guide/operators/explore-operators.md
- Operator guides:
- The Random Walk Operator: user-guide/operators/random-walk.md
- The Ray Tune Operator: user-guide/operators/ray-tune.md
- The TRIM Operator: user-guide/operators/trim.md
- Advanced:
- Running experiments on single entities: user-guide/advanced/run-experiment.md
- Running ado on remote Ray clusters: user-guide/advanced/remote-execution.md
- Installing Backend Services: user-guide/advanced/backend-services.md
- Migrating from 1.x: user-guide/advanced/migration-ado-1x-to-2x.md
- Developer Guide:
- Getting Started: developer-guide/getting-started.md
- Plugin Development:
- Adding custom experiments: developer-guide/creating-custom-experiments.md
- Creating Actuator Classes: developer-guide/creating-actuator-classes.md
- Creating Operators: developer-guide/creating-operators.md
- Contributing:
- Contributing: developer-guide/contributing.md
- Developing ado: developer-guide/developing.md
- Examples:
- user-guide/examples/index.md
- Tutorials:
- "The basics: your first ado experiment campaign": user-guide/examples/tutorials/density-example.md
- "Beyond the basics: ado with real data": user-guide/examples/tutorials/random-walk.md
- Search:
- Search a space with an optimizer: user-guide/examples/best-configuration-search.md
- Search based on a custom objective: user-guide/examples/search-custom-objective.md
- Analysis:
- Identify the important dimensions of a space: user-guide/examples/lhu.md
- Quickly building a predictive model: user-guide/examples/trim.md
- Fine-tuning:
- Measure fine-tuning throughput locally: user-guide/examples/finetune-locally.md
- Measure fine-tuning throughput on a RayCluster: user-guide/examples/finetune-remotely.md
- vLLM Performance:
- Testing the throughput of an inference endpoint: user-guide/examples/vllm-performance-endpoint.md
- Exploring vLLM deployment configurations: user-guide/examples/vllm-performance-full.md
- Benchmarking geospatial models with vLLM: user-guide/examples/vllm-performance-geospatial.md
- Concepts:
- The core ado concepts: concepts/core-concepts.md
- Properties and Domains: concepts/properties-and-domains.md
- Experiments and Actuators: concepts/actuators.md
- Entities and Entity Spaces: concepts/entity-spaces.md
- Discovery Spaces: concepts/discovery-spaces.md
- Shared Sample Stores: concepts/data-sharing.md
- CLI Reference: cli-reference/index.md