-
Notifications
You must be signed in to change notification settings - Fork 64
/
Copy pathmkdocs.yml
460 lines (450 loc) · 29.2 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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
site_name: Run:ai Documentation Library
site_url: https://docs.run.ai/
copyright: Copyright © 2020 - 2024 Run:ai
repo_url: https://github.com/run-ai/docs/
edit_uri: edit/master/docs/
docs_dir: docs
theme:
name: material
custom_dir: overrides
language: en
favicon: images/favicon.ico
logo: images/RUNAI-LOGO-DIGITAL-2C_WP.svg
features:
- navigation.indexes
- navigation.tabs
- navigation.tabs.sticky
- search.highlight
- content.code.annotate
- content.tabs.link
- search.suggest
- content.action.edit
- navigation.top
- toc.follow
- navigation.path
- content.code.copy
icon:
edit: material/pencil
view: material/eye
extra_css:
- stylesheets/extra.css
# strict: true
markdown_extensions:
- footnotes
# - markdown_include.include
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: ["docs/snippets", "docs/admin"]
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
- admonition
- attr_list
- meta
- tables
- toc:
permalink: True
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/runailabs
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/company/runailabs/
analytics:
provider: google
property: UA-122651141-1
version:
provider: mike
plugins:
- mike:
version_selector: true
canonical_version: null
- search:
lang: en
- git-revision-date-localized:
enable_creation_date: true
type: timeago
- glightbox:
zoomable: true
draggable: true
skip_classes:
- skip-lightbox
- minify:
minify_html: true
- redirects:
redirect_maps:
'index.md' : 'home/overview.md'
'admin/runai-setup/self-hosted/k8s/ui.md' : 'admin/runai-setup/self-hosted/k8s/backend.md'
'admin/runai-setup/advanced/non-root-containers.md' : 'admin/authentication/non-root-containers.md'
'admin/runai-setup/config/non-root-containers.md' : 'admin/authentication/non-root-containers.md'
'admin/runai-setup/config/researcher-authentication.md' : 'admin/authentication/researcher-authentication.md'
'admin/runai-setup/cluster-setup/cluster-troubleshooting.md' : 'admin/troubleshooting/troubleshooting.md'
'admin/runai-setup/cluster-setup/nvidia.md' : 'admin/runai-setup/cluster-setup/cluster-prerequisites.md'
'admin/runai-setup/self-hosted/ocp/ocp-dependencies.md' : 'admin/runai-setup/self-hosted/ocp/preparations.md'
'admin/runai-setup/cluster-setup/researcher-authentication.md' : 'admin/authentication/authentication-overview.md'
'admin/runai-setup/authentication/sso.md' : 'admin/authentication/authentication-overview.md'
'admin/researcher-setup/cli-troubleshooting.md' : 'admin/troubleshooting/troubleshooting.md'
'admin/admin-ui-setup/overview.md' : 'platform-admin/aiinitiatives/overview.md' # installation points here
'admin/admin-ui-setup/project-setup.md' : 'platform-admin/aiinitiatives/org/projects.md'
'admin/admin-ui-setup/department-setup.md' : 'platform-admin/aiinitiatives/org/departments.md'
'admin/admin-ui-setup/admin-ui-users.md' : 'admin/authentication/users.md'
'admin/runai-setup/authentication/authentication-overview.md' : 'admin/authentication/authentication-overview.md'
'admin/runai-setup/authentication/researcher-authentication.md' : 'admin/authentication/researcher-authentication.md'
'admin/admin-ui-setup/credentials-setup.md' : 'platform-admin/workloads/assets/credentials.md'
'admin/admin-ui-setup/templates.md' : 'platform-admin/workloads/assets/templates.md'
'admin/admin-ui-setup/dashboard-analysis.md' : 'platform-admin/performance/dashboard-analysis.md'
'admin/admin-ui-setup/deployments.md' : 'platform-admin/workloads/overviews/managing-workloads.md'
'admin/admin-ui-setup/jobs.md' : 'platform-admin/workloads/overviews/managing-workloads.md'
'admin/workloads/policies/README.md' : 'platform-admin/workloads/policies/overview.md'
'admin/workloads/README.md' : 'platform-admin/workloads/overviews/introduction-to-workloads.md'
'admin/troubleshooting/cluster-health-check.md' : 'admin/config/clusters.md'
'admin/runai-setup/config/overview.md' : 'admin/config/overview.md'
'admin/runai-setup/config/node-roles.md' : 'admin/config/node-roles.md'
'admin/runai-setup/config/clusters.md' : 'admin/config/clusters.md'
'admin/runai-setup/config/shared-storage.md' : 'admin/config/shared-storage.md'
'admin/runai-setup/config/default-scheduler.md' : 'admin/config/default-scheduler.md'
'admin/runai-setup/config/access-roles.md' : 'admin/config/access-roles.md'
'admin/runai-setup/config/allow-external-access-to-containers.md' : 'admin/config/allow-external-access-to-containers.md'
'admin/runai-setup/config/cli-admin-install.md' : 'admin/config/cli-admin-install.md'
'admin/runai-setup/config/node-affinity-with-cloud-node-pools.md' : 'admin/config/node-affinity-with-cloud-node-pools.md'
'admin/runai-setup/config/org-cert.md' : 'admin/config/org-cert.md'
'admin/runai-setup/config/large-clusters.md' : 'admin/config/large-clusters.md'
'admin/runai-setup/notifications/notifications.md' : 'admin/config/notifications.md'
'admin/runai-setup/maintenance/node-downtime.md' : 'admin/maintenance/node-downtime.md'
'admin/runai-setup/maintenance/alert-monitoring.md' : 'admin/maintenance/alert-monitoring.md'
'admin/runai-setup/maintenance/audit-log.md' : 'admin/maintenance/audit-log.md'
'admin/researcher-setup/cluster-wide-pvc.md' : 'admin/config/cluster-wide-pvc.md'
'admin/researcher-setup/limit-to-node-group.md' : 'admin/config/limit-to-node-group.md'
'admin/authentication/rbac.md' : 'admin/authentication/roles.md'
'platform-admin/workloads/policies/README.md' : 'platform-admin/workloads/policies/overview.md'
'platform-admin/workloads/inference-overview.md' : 'Researcher/workloads/inference/inference-overview.md'
'developer/deprecated/inference/submit-via-yaml.md' : 'developer/cluster-api/other-resources.md'
'developer/admin-rest-api/data-volumes.md' : 'platform-admin/workloads/assets/data-volumes.md'
'developer/cluster-api/submit-cron-yaml.md' : 'developer/cluster-api/other-resources.md'
'Researcher/scheduling/using-node-pools.md' : 'platform-admin/aiinitiatives/resources/node-pools.md'
'Researcher/user-interface/workspaces/blocks/building-blocks.md' : 'Researcher/workloads/assets/overview.md'
'Researcher/user-interface/workspaces/blocks/environments.md' : 'Researcher/workloads/assets/environments.md'
'Researcher/user-interface/workspaces/blocks/compute.md' : 'Researcher/workloads/assets/compute.md'
'Researcher/user-interface/workspaces/blocks/datasources.md' : 'Researcher/workloads/assets/datasources.md'
'Researcher/user-interface/workspaces/blocks/existing-PVC.md' : 'Researcher/workloads/assets/datasources.md'
'Researcher/user-interface/workspaces/create/create-env.md' : 'Researcher/workloads/assets/environments.md'
'Researcher/user-interface/workspaces/create/create-compute.md' : 'Researcher/workloads/assets/compute.md'
'Researcher/user-interface/workspaces/create/create-ds.md' : 'Researcher/workloads/assets/datasources.md'
'Researcher/user-interface/trainings.md' : 'Researcher/workloads/training/standard-training/trainings-v2.md'
'Researcher/workloads/trainings.md' : 'Researcher/workloads/training/standard-training/trainings-v2.md'
'Researcher/user-interface/workspaces/overview.md' : 'Researcher/workloads/workspaces/overview.md'
'Researcher/user-interface/workspaces/overview.md' : 'Researcher/workloads/overviews/workload-types.md'
'Researcher/user-interface/workspaces/create/workspace-v2.md' : 'Researcher/workloads/workspaces/workspace-v2.md'
'Researcher/user-interface/workspaces/statuses.md': 'Researcher/workloads/overviews/managing-workloads.md'
'snippets/common-submit-cli-commands.md' : 'Researcher/cli-reference/new-cli/runai.md'
'platform-admin/workloads/assets/building-blocks.md' : 'platform-admin/workloads/assets/overview.md'
'Researcher/workloads/assets/building-blocks.md' : 'Researcher/workloads/assets/overview.md'
'Researcher/workloads/statuses.md' : 'Researcher/workloads/overviews/managing-workloads.md'
'platform-admin/workloads/submitting-workloads.md' : 'platform-admin/workloads/overviews/managing-workloads.md'
'Researcher/workloads/workload-support.md' : 'Researcher/workloads/overviews/introduction-to-workloads.md'
'Researcher/workloads/overviews/workload-support.md' : 'Researcher/workloads/overviews/introduction-to-workloads.md'
'admin/integration/kubeflow.md' : 'platform-admin/integrations/integration-overview.md'
'admin/integration/jupyterhub.md' : 'platform-admin/integrations/integration-overview.md'
'admin/integration/airflow.md' : 'platform-admin/integrations/integration-overview.md'
'admin/integration/mlflow.md' : 'platform-admin/integrations/integration-overview.md'
'admin/integration/seldon.md' : 'platform-admin/integrations/integration-overview.md'
'admin/integration/clearml.md' : 'platform-admin/integrations/integration-overview.md'
'admin/integration/argo-workflows.md' : 'platform-admin/integrations/integration-overview.md'
'admin/integration/weights-and-biases.md' : 'platform-admin/integrations/integration-overview.md'
'admin/integration/spark.md' : 'platform-admin/integrations/integration-overview.md'
'admin/integration/ray.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/kubeflow.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/jupyterhub.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/airflow.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/mlflow.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/seldon.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/clearml.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/argo-workflows.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/weights-and-biases.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/spark.md' : 'platform-admin/integrations/integration-overview.md'
'Administrator/integration/ray.md' : 'platform-admin/integrations/integration-overview.md'
'platform-admin/workloads/assets/secrets.md' : 'Researcher/best-practices/secrets-as-env-var-in-cli.md'
'admin/runai-setup/access-control/rbac.md' : 'admin/authentication/roles.md'
'platform-admin/workloads/assets/existing-PVC.md' : 'platform-admin/workloads/assets/datasources.md'
'Researcher/scheduling/job-statuses.md' : 'platform-admin/workloads/overviews/managing-workloads.md'
'Researcher/scheduling/strategies.md' : 'Researcher/scheduling/the-runai-scheduler.md'
'platform-admin/workloads/integrations.md' : 'platform-admin/integrations/integration-overview.md'
'Researcher/scheduling/karpenter.md' : 'platform-admin/integrations/karpenter.md'
'platform-admin/workloads/workload-overview.md' : 'platform-admin/workloads/overviews/introduction-to-workloads.md'
nav:
- Home:
- 'Overview': 'home/overview.md'
- 'System Components' : 'home/components.md'
- 'Whats New' :
- 'Run:ai SaaS Updates' : 'home/saas-updates.md'
- 'Version 2.20' : 'home/whats-new-2-20.md'
- 'Version 2.19' : 'home/whats-new-2-19.md'
- 'Version 2.18' : 'home/whats-new-2-18.md'
- 'Version 2.17' : 'home/whats-new-2-17.md'
- 'Version 2.16' : 'home/whats-new-2-16.md'
- 'Version 2.15' : 'home/whats-new-2-15.md'
- 'Version 2.13' : 'home/whats-new-2-13.md'
- 'Hotfixes':
- 'Hotfixes for 2.19' : 'home/changelog/hotfixes-2-19.md'
- 'Hotfixes for 2.18' : 'home/changelog/hotfixes-2-18.md'
- 'Hotfixes for 2.17' : 'home/changelog/hotfixes-2-17.md'
- 'Hotfixes for 2.16' : 'home/changelog/hotfixes-2-16.md'
- 'Hotfixes for 2.15' : 'home/changelog/hotfixes-2-15.md'
- 'Hotfixes for 2.13' : 'home/changelog/hotfixes-2-13.md'
- 'Data Privacy' : 'home/data-privacy-details.md'
- 'Infrastructure Administrator' :
- 'Overview' : 'admin/overview-administrator.md'
- 'Installation' :
- 'Installation Types' : 'admin/runai-setup/installation-types.md'
- 'Classic (SaaS)' :
- 'Introduction' : 'admin/runai-setup/cluster-setup/cluster-setup-intro.md'
- 'System Requirements' : 'admin/runai-setup/cluster-setup/cluster-prerequisites.md'
- 'Network Requirements' : 'admin/runai-setup/cluster-setup/network-req.md'
- 'Cluster Install' : 'admin/runai-setup/cluster-setup/cluster-install.md'
- 'Customize Installation' : 'admin/runai-setup/cluster-setup/customize-cluster-install.md'
- 'Manually Create Projects' : 'admin/runai-setup/cluster-setup/project-management.md'
- 'Cluster Upgrade' : 'admin/runai-setup/cluster-setup/cluster-upgrade.md'
- 'Cluster Uninstall' : 'admin/runai-setup/cluster-setup/cluster-delete.md'
- 'Install using Base Command Manager' : 'admin/runai-setup/cluster-setup/dgx-bundle.md'
- 'Self-hosted' :
- 'Overview' : 'admin/runai-setup/self-hosted/overview.md'
- 'Kubernetes-based' :
- 'Prerequisites' : 'admin/runai-setup/self-hosted/k8s/prerequisites.md'
- 'Preparations' : 'admin/runai-setup/self-hosted/k8s/preparations.md'
- 'Install Control Plane' : 'admin/runai-setup/self-hosted/k8s/backend.md'
- 'Install a Cluster' : 'admin/runai-setup/self-hosted/k8s/cluster.md'
- 'Install additional Clusters' : 'admin/runai-setup/self-hosted/k8s/additional-clusters.md'
- 'Manually Create Projects' : 'admin/runai-setup/self-hosted/k8s/project-management.md'
- 'Next Steps' : 'admin/runai-setup/self-hosted/k8s/next-steps.md'
- 'Upgrade' : 'admin/runai-setup/self-hosted/k8s/upgrade.md'
- 'Uninstall' : 'admin/runai-setup/self-hosted/k8s/uninstall.md'
- 'OpenShift-based' :
- 'Prerequisites' : 'admin/runai-setup/self-hosted/ocp/prerequisites.md'
- 'Preparations' : 'admin/runai-setup/self-hosted/ocp/preparations.md'
- 'Install Control Plane' : 'admin/runai-setup/self-hosted/ocp/backend.md'
- 'Install a Cluster' : 'admin/runai-setup/self-hosted/ocp/cluster.md'
- 'Install additional Clusters' : 'admin/runai-setup/self-hosted/ocp/additional-clusters.md'
- 'Manually Create Projects' : 'admin/runai-setup/self-hosted/ocp/project-management.md'
- 'Next Steps' : 'admin/runai-setup/self-hosted/ocp/next-steps.md'
- 'Upgrade' : 'admin/runai-setup/self-hosted/ocp/upgrade.md'
- 'Uninstall' : 'admin/runai-setup/self-hosted/ocp/uninstall.md'
- 'Researcher Setup' :
- 'Introduction' : 'admin/researcher-setup/researcher-setup-intro.md'
- 'Install the V1 CLI' : 'admin/researcher-setup/cli-install.md'
- 'Install the V2 CLI' : 'admin/researcher-setup/new-cli-install.md'
- 'Configuration' :
- 'Overview' : 'admin/config/overview.md'
- 'Clusters' : 'admin/config/clusters.md'
- 'Advanced Cluster Configuration' : 'admin/config/advanced-cluster-config.md'
- 'Secure your Cluster' : 'admin/config/secure-cluster.md'
- 'Shared Storage' : 'admin/config/shared-storage.md'
- 'Local Certificate Authority' : 'admin/config/org-cert.md'
- 'Install Administrator CLI' : 'admin/config/cli-admin-install.md'
- 'Backup & Restore' : 'admin/config/dr.md'
- 'High Availability' : 'admin/config/ha.md'
- 'Scaling' : 'admin/config/large-clusters.md'
- 'Email and System Notifications': 'admin/config/notifications.md'
- 'Set Node Roles' : 'admin/config/node-roles.md'
- 'Review Kubernetes Access provided to Run:ai' : 'admin/config/access-roles.md'
- 'External access to Containers' : 'admin/config/allow-external-access-to-containers.md'
- 'Node Affinity with Cloud Node Pools' : 'admin/config/node-affinity-with-cloud-node-pools.md'
- 'Setup cluster wide PVC' : 'admin/config/cluster-wide-pvc.md'
- 'Group Nodes' : 'admin/config/limit-to-node-group.md'
- 'Workload Deletion Protection' : 'admin/config/workload-ownership-protection.md'
- 'Mark Assets for Run:ai' : 'admin/config/create-k8s-assets-in-advance.md'
- 'Set Default Scheduler' : 'admin/config/default-scheduler.md'
- 'Maintenance' :
- 'Monitoring and maintenance Overview' : 'admin/maintenance/overview.md'
- 'Node Maintenance' : 'admin/maintenance/node-downtime.md'
- 'System Monitoring' : 'admin/maintenance/alert-monitoring.md'
- 'Audit Log' : 'admin/maintenance/audit-log.md'
- 'Authentication & Authorization' :
- 'Overview' : 'admin/authentication/authentication-overview.md'
- 'Single Sign-On' :
- 'Setup SSO with SAML' : 'admin/authentication/sso/saml.md'
- 'Setup SSO with OpenID Connect' : 'admin/authentication/sso/openidconnect.md'
- 'Setup SSO with OpenShift' : 'admin/authentication/sso/openshift.md'
- 'Users' : 'admin/authentication/users.md'
- 'Applications' : 'admin/authentication/applications.md'
- 'Roles' : 'admin/authentication/roles.md'
- 'Access Rules' : 'admin/authentication/accessrules.md'
- 'Researcher Authentication' : 'admin/authentication/researcher-authentication.md'
- 'User Identity in Container' : 'admin/authentication/non-root-containers.md'
- 'Troubleshooting' :
- 'Logs Collection' : 'admin/troubleshooting/logs-collection.md'
- 'Troubleshooting' : 'admin/troubleshooting/troubleshooting.md'
- 'Diagnostics' : 'admin/troubleshooting/diagnostics.md'
- 'Platform Administrator' :
- 'Overview' : 'platform-admin/overview.md'
- 'Authentication & Authorization' :
- 'Users' : 'platform-admin/authentication/users.md'
- 'Applications' : 'platform-admin/authentication/applications.md'
- 'Roles' : 'platform-admin/authentication/roles.md'
- 'Access Rules' : 'platform-admin/authentication/accessrules.md'
- 'Managing AI Intiatives' :
- 'Adapting AI initiatives to your organization' : 'platform-admin/aiinitiatives/overview.md'
- 'Managing your Organization' :
- 'Projects' : 'platform-admin/aiinitiatives/org/projects.md'
- 'Departments' : 'platform-admin/aiinitiatives/org/departments.md'
- 'Scheduling Rules' : 'platform-admin/aiinitiatives/org/scheduling-rules.md'
- 'Managing your resources' :
- 'Nodes' : 'platform-admin/aiinitiatives/resources/nodes.md'
- 'Configuring NVIDIA MIG Profiles' : platform-admin/aiinitiatives/resources/configuring-mig-profiles.md
- 'Node Pools' : 'platform-admin/aiinitiatives/resources/node-pools.md'
- 'Workloads' :
- 'Introduction to Workloads' : 'platform-admin/workloads/overviews/introduction-to-workloads.md'
- "Workload Types": 'platform-admin/workloads/overviews/workload-types.md'
- 'Workloads' : 'platform-admin/workloads/overviews/managing-workloads.md'
- 'Workload Assets' :
- 'Overview' : 'platform-admin/workloads/assets/overview.md'
- 'Environments' : 'platform-admin/workloads/assets/environments.md'
- 'Data Sources' : 'platform-admin/workloads/assets/datasources.md'
- 'Data Volumes': 'platform-admin/workloads/assets/data-volumes.md'
- 'Compute Resources': 'platform-admin/workloads/assets/compute.md'
- 'Credentials' : 'platform-admin/workloads/assets/credentials.md'
- 'Workload Templates' :
- 'Workspace Templates': 'platform-admin/workloads/assets/templates.md'
- 'Policies' :
- 'Overview' : 'platform-admin/workloads/policies/overview.md'
- 'Policies' : 'platform-admin/workloads/policies/workspaces-policy.md'
- 'Policies Examples' : 'platform-admin/workloads/policies/policy-examples.md'
- 'Policies Reference' : 'platform-admin/workloads/policies/policy-reference.md'
- 'Older Policies' :
- 'Policies V1' : 'platform-admin/workloads/policies/old-policies.md'
- 'Integrations' :
- 'Overview' : 'platform-admin/integrations/integration-overview.md'
- 'Working with Karpenter' : 'platform-admin/integrations/karpenter.md'
- 'Review your performance' :
- 'Dashboard Analysis' : 'platform-admin/performance/dashboard-analysis.md'
- 'Reports' : 'platform-admin/performance/reports.md'
- 'Best Practices' :
- 'From Docker to Run:ai ' : 'admin/researcher-setup/docker-to-runai.md'
- 'System Configuration' :
- 'Administrator Messages' : 'admin/config/admin-messages.md'
- 'Researcher' :
- 'Overview' : 'Researcher/overview-researcher.md'
- 'Quickstart Guides' :
- 'Run:ai Quickstart Guides' : 'Researcher/Walkthroughs/quickstart-overview.md'
- 'Build' :
- 'Basics' : 'Researcher/Walkthroughs/walkthrough-build.md'
- 'Visual Studio Code Web' : 'Researcher/Walkthroughs/quickstart-vscode.md'
- 'Build with Connected Ports' : 'Researcher/Walkthroughs/walkthrough-build-ports.md'
- 'Inference' : 'Researcher/Walkthroughs/quickstart-inference.md'
# - 'GPU Allocation' :
- 'GPU Fractions' : 'Researcher/Walkthroughs/walkthrough-fractions.md'
# - 'Dynamic MIG' : 'Researcher/Walkthroughs/quickstart-mig.md'
- 'Scheduling Basics' :
- 'Over-Quota, Basic Fairness & Bin-Packing' : 'Researcher/Walkthroughs/walkthrough-overquota.md'
- 'Queue Fairness' : 'Researcher/Walkthroughs/walkthrough-queue-fairness.md'
- 'Workloads in Run:ai' :
- 'Introduction to Workloads' : 'Researcher/workloads/overviews/introduction-to-workloads.md'
- "Workload Types": 'Researcher/workloads/overviews/workload-types.md'
- 'Workloads' : 'Researcher/workloads/overviews/managing-workloads.md'
- 'Workload Assets' :
- 'Overview' : 'Researcher/workloads/assets/overview.md'
- 'Environments' : 'Researcher/workloads/assets/environments.md'
- 'Data Sources' : 'Researcher/workloads/assets/datasources.md'
- 'Data Volumes': 'Researcher/workloads/assets/data-volumes.md'
- 'Compute Resources': 'Researcher/workloads/assets/compute.md'
- 'Credentials' : 'Researcher/workloads/assets/credentials.md'
- 'Workload Templates' :
- 'Workspace Templates': 'Researcher/workloads/assets/templates.md'
- 'Experiment Using Workspaces' :
- 'Running Workspaces' : 'Researcher/workloads/workspaces/workspace-v2.md'
- 'Quick Starts' :
- 'Running Jupyter Notebook Using Workspaces' : 'Researcher/workloads/workspaces/quickstart-jupyter.md'
- 'Train Models Using Training' :
- 'Standard Training' :
- 'Train Models Using a Standard Training Workload' : 'Researcher/workloads/training/standard-training/trainings-v2.md'
- 'Quick Starts' :
- 'Run your First Standard Training' : 'Researcher/workloads/training/standard-training/quickstart-standard-training.md'
- 'Distributed Training' :
- 'Train Models Using a Distributed Training Workload' : 'Researcher/workloads/training/distributed-training/distributed-training.md'
- 'Quick Starts' :
- 'Run your First Distributed Training' : 'Researcher/workloads/training/distributed-training/quickstart-distributed-training.md'
- 'Deploy Models Using Inference' :
- 'Overview': 'Researcher/workloads/inference/inference-overview.md'
- 'Deploy a Custom Inference Workload' : 'Researcher/workloads/inference/custom-inference.md'
- 'Deploy Inference Workloads from Hugging Face' : 'Researcher/workloads/inference/hugging-face-inference.md'
- 'Deploy Inference Workloads with NVIDIA NIM' : 'Researcher/workloads/inference/nim-inference.md'
# - 'Scheduling workloads to AWS placement groups' : 'Researcher/scheduling/schedule-to-aws-groups.md'
- 'Command Line Interface' :
- 'CLI V2':
- 'Overview': 'Researcher/cli-reference/new-cli/overview.md'
- 'CLI Reference': 'Researcher/cli-reference/new-cli/runai.md'
- 'CLI Examples': 'Researcher/cli-reference/new-cli/cli-examples.md'
- 'CLI Guides':
- 'Set cluster authorization': 'Researcher/cli-reference/new-cli/guides/set-kubeconfig-with-oidc-parameters.md'
- 'CLI V1':
- 'Introduction' : 'Researcher/cli-reference/Introduction.md'
- 'runai attach' : 'Researcher/cli-reference/runai-attach.md'
- 'runai bash' : 'Researcher/cli-reference/runai-bash.md'
- 'runai config' : 'Researcher/cli-reference/runai-config.md'
- 'runai delete' : 'Researcher/cli-reference/runai-delete.md'
- 'runai describe' : 'Researcher/cli-reference/runai-describe.md'
- 'runai exec' : 'Researcher/cli-reference/runai-exec.md'
- 'runai list' : 'Researcher/cli-reference/runai-list.md'
- 'runai login' : 'Researcher/cli-reference/runai-login.md'
- 'runai logout' : 'Researcher/cli-reference/runai-logout.md'
- 'runai logs' : 'Researcher/cli-reference/runai-logs.md'
- 'runai port-forward' : 'Researcher/cli-reference/runai-port-forwarding.md'
- 'runai resume' : 'Researcher/cli-reference/runai-resume.md'
- 'runai submit' : 'Researcher/cli-reference/runai-submit.md'
- 'runai submit-dist mpi' : 'Researcher/cli-reference/runai-submit-dist-mpi.md'
- 'runai submit-dist pytorch' : 'Researcher/cli-reference/runai-submit-dist-pytorch.md'
- 'runai submit-dist tf' : 'Researcher/cli-reference/runai-submit-dist-TF.md'
- 'runai submit-dist xgboost' : 'Researcher/cli-reference/runai-submit-dist-xgboost.md'
- 'runai suspend' : 'Researcher/cli-reference/runai-suspend.md'
- 'runai top node' : 'Researcher/cli-reference/runai-top-node.md'
- 'runai update' : 'Researcher/cli-reference/runai-update.md'
- 'runai version' : 'Researcher/cli-reference/runai-version.md'
- 'runai whoami' : 'Researcher/cli-reference/runai-whoami.md'
- 'Best Practices' :
- 'Bare-Metal to Docker Images' : 'Researcher/best-practices/bare-metal-to-docker-images.md'
- 'Convert a Workload to Run Unattended' : 'Researcher/best-practices/convert-to-unattended.md'
- 'Save Deep Learning Checkpoints' : 'Researcher/best-practices/save-dl-checkpoints.md'
- 'Environment Variables' : 'Researcher/best-practices/env-variables.md'
- 'Email Notifications' : 'Researcher/best-practices/researcher-notifications.md'
- 'Secrets as Environment Variables (CLI)' : 'Researcher/best-practices/secrets-as-env-var-in-cli.md'
- 'Scheduling' :
- 'The Run:ai Scheduler' : 'Researcher/scheduling/the-runai-scheduler.md'
- 'Allocation of GPU Fractions' : 'Researcher/scheduling/fractions.md'
- 'Allocation of CPU and Memory' : 'Researcher/scheduling/allocation-of-cpu-and-memory.md'
- 'Advanced' :
- 'Dynamic GPU Fractions': 'Researcher/scheduling/dynamic-gpu-fractions.md'
- 'Optimize performance with the Node Level Scheduler': 'Researcher/scheduling/node-level-scheduler.md'
- 'GPU Time Slicing' : 'Researcher/scheduling/GPU-time-slicing-scheduler.md'
- 'GPU Memory Swap' : 'Researcher/scheduling/gpu-memory-swap.md'
# - 'Job Statuses' : 'Researcher/scheduling/job-statuses.md'
# - 'Scheduling Strategies' : 'Researcher/scheduling/strategies.md'
- 'Researcher Tools' :
- 'Visual Studio Code' : 'Researcher/tools/dev-vscode.md'
- 'PyCharm' : 'Researcher/tools/dev-pycharm.md'
- 'X11 & PyCharm' : 'Researcher/tools/dev-x11forward-pycharm.md'
- 'Jupyter Notebook' : 'Researcher/tools/dev-jupyter.md'
- 'TensorBoard' : 'Researcher/tools/dev-tensorboard.md'
- 'Use Cases' : 'Researcher/use-cases.md'
- 'Developer' :
- 'Overview' : 'developer/overview-developer.md'
- 'User Applications' : 'developer/user-applications.md'
- 'API Authentication' : 'developer/rest-auth.md'
- 'REST API' : 'developer/admin-rest-api/overview.md'
- 'Cluster API (Deprecated)' :
- 'Overview' : 'developer/cluster-api/workload-overview-dev.md'
- 'Submit Workload via YAML' : 'developer/cluster-api/submit-yaml.md'
- 'Submit Workload via HTTP/REST' : 'developer/cluster-api/submit-rest.md'
- 'Reference' : 'developer/cluster-api/reference.md'
- 'Metrics' :
- 'Metrics via API' : 'developer/metrics/metrics-api.md'
- '(Deprecated) Metrics via Prometheus' : 'developer/metrics/metrics.md'
- 'Kubernetes Workloads Integration' : 'developer/cluster-api/other-resources.md'