-
Notifications
You must be signed in to change notification settings - Fork 556
/
mkdocs.yml
268 lines (244 loc) · 10.6 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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
site_name: IREE
site_url: https://iree.dev/
repo_url: https://github.com/openxla/iree
repo_name: openxla/iree
edit_uri: blob/main/docs/website/docs/
theme:
name: material
logo: assets/images/ghost.svg
logo_alt: IREE
icon:
repo: fontawesome/brands/github
edit: material/file-eye-outline
font:
text: Noto
code: Noto Sans Mono
favicon: assets/images/ghost.svg
custom_dir: overrides
features:
- content.action.edit # Link to view/edit documentation source on GitHub
- content.code.annotate # Allow inline annotations
- content.code.copy # Enable copy button
- content.tabs.link # Link content tabs across site (e.g. Windows/Linux)
- navigation.instant # Ajax-style dynamic loading (faster)
- navigation.tracking # Update URL in address bar with the active anchor
- navigation.sections # Group sections without collapsible buttons
- navigation.expand # Start sections expanded
- navigation.tabs # Show primary sections in tabs below the header
- navigation.tabs.sticky # Keep tabs visible at the top when scrolled
- navigation.top # "Back to top" button
- navigation.indexes # Section names can link to index.md pages
- toc.follow # Scroll the TOC panel to follow the reader
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
extra:
homepage: https://iree.dev/
# TODO(scotttodd): join mkdocs-material insiders and remove notice?
# (we *can* remove the notice without joining)
# generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/openxla/iree
name: IREE on GitHub
- icon: fontawesome/brands/discord
link: https://discord.gg/26P4xW4
name: IREE Discord Server
- icon: fontawesome/solid/users
link: https://groups.google.com/forum/#!forum/iree-discuss
name: IREE Discuss Google Group
status:
new: Recently updated
extra_css:
- assets/stylesheets/extra.css
- assets/stylesheets/iree.css
copyright: Copyright © 2024 The IREE Authors
markdown_extensions:
- abbr
- admonition
- attr_list
- footnotes
- meta
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
# Support for embedding external files (e.g. source code samples) via snippets
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#embedding-external-files
- pymdownx.snippets:
base_path: ["../../"] # Use paths relative to the repository root
check_paths: true
# Diagram support, see
# https://squidfunk.github.io/mkdocs-material/reference/diagrams/
# Docs : https://mermaid.js.org/
# Editor: https://mermaid.live/edit
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- tables
- toc: # Table of Contents
permalink: 'link' # Use Material font's "link" icon; see iree.css
toc_depth: 4
# Navigation with explicit ordering and nesting.
# https://www.mkdocs.org/user-guide/configuration/#nav
# Note: may include external links and titles are optional for internal links
nav:
- Home: "index.md"
- "Building from source":
- "building-from-source/index.md"
- "building-from-source/getting-started.md"
- "building-from-source/android.md"
- "building-from-source/ios.md"
- "building-from-source/riscv.md"
- "Guides":
- "guides/index.md"
- "ML frameworks":
- "guides/ml-frameworks/index.md"
- JAX: "guides/ml-frameworks/jax.md"
- PyTorch: "guides/ml-frameworks/pytorch.md"
- TensorFlow: "guides/ml-frameworks/tensorflow.md"
- TensorFlow Lite: "guides/ml-frameworks/tflite.md"
- "Deployment configurations":
- "guides/deployment-configurations/index.md"
- CPU: "guides/deployment-configurations/cpu.md"
- CPU - Bare-Metal: "guides/deployment-configurations/bare-metal.md"
- GPU - Vulkan: "guides/deployment-configurations/gpu-vulkan.md"
- GPU - CUDA: "guides/deployment-configurations/gpu-cuda.md"
- GPU - ROCm: "guides/deployment-configurations/gpu-rocm.md"
- GPU - Metal: "guides/deployment-configurations/gpu-metal.md"
- "Reference":
- "reference/index.md"
- "API bindings":
- "reference/bindings/index.md"
- C API: "reference/bindings/c-api.md"
- Python: "reference/bindings/python.md"
- "MLIR dialects":
- "reference/mlir-dialects/index.md"
# Note: these files are generated by generate_extra_files.sh.
- "Internal dialects":
- Check: "reference/mlir-dialects/Check.md"
- Flow: "reference/mlir-dialects/Flow.md"
- HAL: "reference/mlir-dialects/HAL.md"
- HAL/Inline: "reference/mlir-dialects/HALInline.md"
- HAL/Loader: "reference/mlir-dialects/HALLoader.md"
- IO/Parameters: "reference/mlir-dialects/IOParameters.md"
- Stream: "reference/mlir-dialects/Stream.md"
- Util: "reference/mlir-dialects/Util.md"
- VM: "reference/mlir-dialects/VM.md"
- VMVX: "reference/mlir-dialects/VMVX.md"
# Dialects from llvm-external-projects/iree-dialects/
- "Public dialects":
- IREEInput: "reference/mlir-dialects/IREEInput.md"
- IREELinalgExt: "reference/mlir-dialects/IREELinalgExt.md"
- IREEVectorExt: "reference/mlir-dialects/IREEVectorExt.md"
- "Other topics":
- Glossary: "reference/glossary.md"
- Optimization options: "reference/optimization-options.md"
- Extensions: "reference/extensions.md"
- "Developers":
- "developers/index.md"
- "General development topics":
- "developers/general/contributing.md"
- "developers/general/developer-overview.md"
- "developers/general/developer-tips.md"
- "developers/general/release-management.md"
- "developers/general/testing-guide.md"
- "Building":
- "developers/building/bazel.md"
- "developers/building/emscripten.md"
- "developers/building/cmake-options.md"
- "developers/building/cmake-with-ccache.md"
- "Debugging":
- "developers/debugging/android-with-lldb.md"
- "developers/debugging/compile-time-regressions.md"
- "developers/debugging/gpu.md"
- "developers/debugging/integration-tests.md"
- "developers/debugging/releases.md"
- "developers/debugging/sanitizers.md"
- "Performance":
- "developers/performance/benchmarking.md"
- "developers/performance/benchmark-suites.md"
- "developers/performance/profiling.md"
- "developers/performance/profiling-cpu-events.md"
- "developers/performance/profiling-gpu-vulkan.md"
- "developers/performance/profiling-with-tracy.md"
- "Design docs":
- "developers/design-docs/cuda-backend.md"
- "developers/design-docs/design-roadmap.md"
- "developers/design-docs/function-abi.md"
- "developers/design-docs/invocation-execution-model.md"
- "Other topics":
- "developers/usage-best-practices.md"
- "developers/vulkan-environment-setup.md"
- "Community":
- "community/index.md"
- "Blog":
- "community/blog/index.md"
- "community/tags.md"
# https://www.mkdocs.org/user-guide/configuration/#hooks
hooks:
- custom_edit_url.py
plugins:
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/
- blog:
blog_dir: "community/blog"
blog_toc: true
post_url_date_format: yyyy-MM-dd
post_url_format: "{date}-{slug}"
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
- search
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/
- tags:
tags_file: community/tags.md
# https://github.com/mkdocs/mkdocs-redirects
- redirects:
redirect_maps: # old -> new
"extensions/index.md": "reference/extensions.md"
# "getting-started/" moved under "guides/ml-frameworks/"
"getting-started/index.md": "guides/ml-frameworks/index.md"
"getting-started/tensorflow.md": "guides/ml-frameworks/tensorflow.md"
"getting-started/tflite.md": "guides/ml-frameworks/tflite.md"
"getting-started/jax.md": "guides/ml-frameworks/jax.md"
"getting-started/pytorch.md": "guides/ml-frameworks/pytorch.md"
# "deployment-configurations/" moved under "guides/"
"deployment-configurations/index.md": "guides/deployment-configurations/index.md"
"deployment-configurations/cpu.md": "guides/deployment-configurations/cpu.md"
"deployment-configurations/bare-metal.md": "guides/deployment-configurations/bare-metal.md"
"deployment-configurations/gpu-vulkan.md": "guides/deployment-configurations/gpu-vulkan.md"
"deployment-configurations/gpu-cuda-rocm.md": "guides/deployment-configurations/gpu-cuda.md"
# The CUDA/ROCm page split into two pages
"guides/deployment-configurations/gpu-cuda-rocm.md": "guides/deployment-configurations/gpu-cuda.md"
# "bindings/" moved under "reference/"
"bindings/index.md": "reference/bindings/index.md"
"bindings/c-api.md": "reference/bindings/c-api.md"
"bindings/python.md": "reference/bindings/python.md"
# "blog/" moved under "community/"
"blog/index.md": "community/blog/index.md"
"blog/2021-07-19-tflite-tosa.md": "community/blog/posts/tflite-tosa.md"
"blog/2021-10-13-mmt4d.md": "community/blog/posts/mmt4d.md"
"blog/2021-10-15-cuda-backend.md": "community/blog/posts/cuda-backend.md"
# Some blog post names/paths changed when setting up the blog plugin
"community/blog/2021-07-19-tflite-tosa.md": "community/blog/posts/tflite-tosa.md"
"community/blog/2021-10-13-mmt4d.md": "community/blog/posts/mmt4d.md"
# "Developers" section was added
"guides/developer-tips.md": "developers/general/developer-tips.md"
"developers/building/cmake-options-and-variables.md": "developers/building/cmake-options.md"