{{ message }}
Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
319 lines (314 loc) · 19.7 KB
/
Copy pathmkdocs.yml
File metadata and controls
319 lines (314 loc) · 19.7 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
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
site_name: Run:ai Documentation Library
site_url: https://docs.run.ai/
copyright: Copyright © 2020 - 2023 Run:ai
repo_url: https://github.com/run-ai/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.tabs
- search.highlight
- content.code.annotate
- content.tabs.link
- search.suggest
extra_css:
- stylesheets/extra.css
#strict: true
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
- admonition
- attr_list
- meta
- toc:
permalink: True
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.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
default: latest
plugins:
- mike:
version_selector: true
canonical_version: latest
- search:
lang: en
- git-revision-date-localized:
enable_creation_date: true
type: timeago
# - render_swagger
- minify:
minify_html: true
- redirects:
redirect_maps:
'Administrator/Cluster-Setup/cluster-prerequisites.md' : 'admin/runai-setup/cluster-setup/cluster-prerequisites.md'
'Administrator/Researcher-Setup/cli-install.md' : 'admin/researcher-setup/cli-install.md'
# 'Administrator/Admin-User-Interface-Setup/Working-with-Projects.md' : 'admin/admin-ui-setup/project-setup.md'
# 'Administrator/Admin-User-Interface-Setup/Working-with-Departments.md' : 'admin/admin-ui-setup/department-setup.md'
# 'Researcher/scheduling/The-Run-AI-Scheduler.md' : 'Researcher/scheduling/the-runai-scheduler.md'
# 'Administrator/admin-ui-setup/admin-ui-users.md' : 'admin/admin-ui-setup/admin-ui-users.md'
# 'Administrator/admin-ui-setup/dashboard-analysis.md' : 'admin/admin-ui-setup/dashboard-analysis.md'
# 'Administrator/admin-ui-setup/department-setup.md' : 'admin/admin-ui-setup/department-setup.md'
# 'Administrator/admin-ui-setup/project-setup.md' : 'admin/admin-ui-setup/project-setup.md'
# 'Administrator/Cluster-Setup/access-roles.md' : 'admin/runai-setup/config/access-roles.md'
# 'Administrator/Cluster-Setup/allow-external-access-to-containers.md' : 'admin/runai-setup/config/allow-external-access-to-containers.md'
# 'Administrator/Cluster-Setup/cli-admin-install.md' : 'admin/runai-setup/config/cli-admin-install.md'
# 'Administrator/Cluster-Setup/cluster-delete.md' : 'admin/runai-setup/cluster-setup/cluster-delete.md'
'Administrator/Cluster-Setup/cluster-install.md' : 'admin/runai-setup/cluster-setup/cluster-install.md'
# 'Administrator/Cluster-Setup/cluster-setup-intro.md' : 'admin/runai-setup/cluster-setup/cluster-setup-intro.md'
'Administrator/Cluster-Setup/cluster-upgrade.md' : 'admin/runai-setup/cluster-setup/cluster-upgrade.md'
'Administrator/Cluster-Setup/customize-cluster-install.md' : 'admin/runai-setup/cluster-setup/customize-cluster-install.md'
# 'Administrator/Cluster-Setup/install-k8s.md' : 'admin/runai-setup/cluster-setup/install-k8s.md'
# 'Administrator/Cluster-Setup/node-downtime.md' : 'admin/runai-setup/maintenance/node-downtime.md'
# 'Administrator/Cluster-Setup/node-roles.md' : 'admin/runai-setup/config/node-roles.md'
# 'Administrator/Cluster-Setup/non-root-containers.md' : 'admin/runai-setup/config/non-root-containers.md'
# 'Administrator/Cluster-Setup/nvidia.md' : 'admin/runai-setup/cluster-setup/cluster-prerequisites.md'
# 'Administrator/Cluster-Setup/researcher-authentication.md' : 'admin/runai-setup/authentication/sso.md'
# 'Administrator/Cluster-Setup/single-node-install.md' : 'admin/runai-setup/cluster-setup/single-node-install.md'
# 'Administrator/integration/airflow.md' : 'admin/integration/airflow.md'
# 'Administrator/integration/jupyterhub.md' : 'admin/integration/jupyterhub.md'
# 'Administrator/integration/kubeflow.md' : 'admin/integration/kubeflow.md'
'Administrator/integration/mlflow.md' : 'admin/integration/mlflow.md'
# 'Administrator/overview-admin.md' : 'admin/overview-administrator.md'
# 'Administrator/Researcher-Setup/docker-registry-config.md' : 'admin/researcher-setup/docker-registry-config.md'
# 'Administrator/Researcher-Setup/docker-to-runai.md' : 'admin/researcher-setup/docker-to-runai.md'
# 'Administrator/Researcher-Setup/limit-to-node-group.md' : 'admin/researcher-setup/limit-to-node-group.md'
# 'Administrator/Researcher-Setup/researcher-setup-intro.md' : 'admin/researcher-setup/researcher-setup-intro.md'
# 'Administrator/Researcher-Setup/use-secrets.md' : 'admin/workloads/secrets.md'
# 'admin/researcher-setup/use-secrets.md' : 'admin/workloads/secrets.md'
# 'Administrator/runai-setup/installation-types.md' : 'admin/runai-setup/installation-types.md'
'admin/runai-setup/self-hosted/k8s/ui.md' : 'admin/runai-setup/self-hosted/k8s/backend.md'
'admin/runai-setup/advanced/overview.md' : 'admin/runai-setup/config/overview.md'
'admin/runai-setup/advanced/node-roles.md' : 'admin/runai-setup/config/node-roles.md'
'admin/runai-setup/advanced/researcher-authentication.md' : 'admin/runai-setup/authentication/sso.md'
'admin/runai-setup/advanced/sso.md' : 'admin/runai-setup/authentication/sso.md'
'admin/runai-setup/advanced/access-roles.md' : 'admin/runai-setup/config/access-roles.md'
'admin/runai-setup/advanced/allow-external-access-to-containers.md' : 'admin/runai-setup/config/allow-external-access-to-containers.md'
'admin/runai-setup/advanced/non-root-containers.md' : 'admin/runai-setup/config/non-root-containers.md'
'admin/runai-setup/advanced/cli-admin-install.md' : 'admin/runai-setup/config/cli-admin-install.md'
'admin/runai-setup/advanced/dr.md' : 'admin/runai-setup/config/dr.md'
'admin/runai-setup/advanced/node-downtime.md' : 'admin/runai-setup/maintenance/node-downtime.md'
'admin/runai-setup/advanced/monitoring.md' : 'admin/runai-setup/maintenance/monitoring.md'
'admin/runai-setup/config/researcher-authentication.md' : 'admin/runai-setup/authentication/researcher-authentication.md'
'admin/runai-setup/config/sso.md' : 'admin/runai-setup/authentication/sso.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/runai-setup/authentication/sso.md'
'admin/researcher-setup/cli-troubleshooting.md' : 'admin/troubleshooting/troubleshooting.md'
'developer/deprecated/inference/submit-via-yaml.md' : 'developer/cluster-api/other-resources.md'
'Researcher/researcher-library/rl-hpo-support.md' : 'Researcher/scheduling/hpo.md'
'Researcher/researcher-library/researcher-library-overview.md' : 'Researcher/scheduling/hpo.md'
nav:
- Home:
- 'Overview': 'index.md'
- 'System Components' : 'home/components.md'
- 'Whats New' :
- 'Version 2.9' : 'home/whats-new-2-9.md'
- 'Version 2.8' : 'home/whats-new-2-8.md'
- 'Whats New 2022' : 'home/whats-new-2022.md'
- 'Whats New 2021' : 'home/whats-new-2021.md'
- 'Whats New 2020' : 'home/whats-new-2020.md'
- 'Data Privacy' : 'home/data-privacy-details.md'
- 'Administrator' :
- 'Overview' : 'admin/overview-administrator.md'
- 'Run:ai Setup' :
- 'Installation Types' : 'admin/runai-setup/installation-types.md'
- 'Try on the Cloud' : 'admin/runai-setup/try-azure.md'
- 'Classic (SaaS)' :
- 'Introduction' : 'admin/runai-setup/cluster-setup/cluster-setup-intro.md'
- 'Prerequisites' : 'admin/runai-setup/cluster-setup/cluster-prerequisites.md'
- 'Cluster Install' : 'admin/runai-setup/cluster-setup/cluster-install.md'
- 'Customize Installation' : 'admin/runai-setup/cluster-setup/customize-cluster-install.md'
- 'Cluster Upgrade' : 'admin/runai-setup/cluster-setup/cluster-upgrade.md'
- 'Cluster Delete' : 'admin/runai-setup/cluster-setup/cluster-delete.md'
- 'Kubernetes Install' : 'admin/runai-setup/cluster-setup/install-k8s.md'
# - 'Quick Single Node Install' : 'admin/runai-setup/cluster-setup/single-node-install.md'
- 'NVIDIA DGX Bundle' : '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'
- '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'
- 'Configuration' :
- 'Overview' : 'admin/runai-setup/config/overview.md'
- 'Set Node Roles' : 'admin/runai-setup/config/node-roles.md'
- 'Review Kubernetes Access provided to Run:ai' : 'admin/runai-setup/config/access-roles.md'
- 'External access to Containers' : 'admin/runai-setup/config/allow-external-access-to-containers.md'
- 'User Identity in Container' : 'admin/runai-setup/config/non-root-containers.md'
- 'Install Administrator CLI' : 'admin/runai-setup/config/cli-admin-install.md'
- 'Disaster Recovery' : 'admin/runai-setup/config/dr.md'
- 'Node Affinity with Cloud Node Pools' : 'admin/runai-setup/config/node-affinity-with-cloud-node-pools.md'
- 'Authentication' :
- 'Overview' : 'admin/runai-setup/authentication/authentication-overview.md'
- 'Researcher Authentication' : 'admin/runai-setup/authentication/researcher-authentication.md'
- 'Single Sign-On' : 'admin/runai-setup/authentication/sso.md'
- 'Maintenance' :
- 'Node Downtime' : 'admin/runai-setup/maintenance/node-downtime.md'
- 'Monitoring Cluster Health' : 'admin/runai-setup/maintenance/monitoring.md'
- 'Audit Log' : 'admin/runai-setup/maintenance/audit-log.md'
- 'Researcher Setup' :
- 'Introduction' : 'admin/researcher-setup/researcher-setup-intro.md'
- 'Install the CLI' : 'admin/researcher-setup/cli-install.md'
- 'Use a Docker Registry with Credentials' : 'admin/researcher-setup/docker-registry-config.md'
- 'Group Nodes' : 'admin/researcher-setup/limit-to-node-group.md'
- 'Workloads' :
- 'Overview' : 'admin/workloads/workload-overview-admin.md'
- 'Policies' : 'admin/workloads/policies.md'
- 'Secrets' : 'admin/workloads/secrets.md'
- 'Inference' : 'admin/workloads/inference-overview.md'
- 'User Interface' :
- 'Overview' : 'admin/admin-ui-setup/overview.md'
- 'Users' : 'admin/admin-ui-setup/admin-ui-users.md'
- 'Projects' : 'admin/admin-ui-setup/project-setup.md'
- 'Departments' : 'admin/admin-ui-setup/department-setup.md'
- 'Dashboard Analysis' : 'admin/admin-ui-setup/dashboard-analysis.md'
- 'Jobs' : 'admin/admin-ui-setup/jobs.md'
- 'Deployments' : 'admin/admin-ui-setup/deployments.md'
- 'Troubleshooting' :
- 'Cluster Health' : 'admin/troubleshooting/cluster-health-check.md'
- 'Troubleshooting' : 'admin/troubleshooting/troubleshooting.md'
- 'Diagnostics' : 'admin/troubleshooting/diagnostics.md'
- 'Best Practices' :
- 'From Docker to Run:ai ' : 'admin/researcher-setup/docker-to-runai.md'
- 'Integrations' :
- 'JupyterHub' : 'admin/integration/jupyterhub.md'
- 'Airflow' : 'admin/integration/airflow.md'
- 'MLflow' : 'admin/integration/mlflow.md'
- 'Kubeflow' : 'admin/integration/kubeflow.md'
- 'Seldon Core' : 'admin/integration/seldon.md'
- 'ClearML' : 'admin/integration/clearml.md'
- 'Argo Workflows' : 'admin/integration/argo-workflows.md'
- 'KubeVirt (VM)' : 'admin/integration/kubevirt.md'
- 'Weights & Biases' : 'admin/integration/weights-and-biases.md'
- 'Researcher' :
- 'Overview' : 'Researcher/overview-researcher.md'
- 'Quickstart Guides' :
- 'Run:ai Quickstart Guides' : 'Researcher/Walkthroughs/quickstart-overview.md'
- 'Training' : 'Researcher/Walkthroughs/walkthrough-train.md'
- 'Build' : 'Researcher/Walkthroughs/walkthrough-build.md'
- 'Build with Connected Ports' : 'Researcher/Walkthroughs/walkthrough-build-ports.md'
- 'GPU Fractions' : 'Researcher/Walkthroughs/walkthrough-fractions.md'
- 'Distributed Training Workloads' : 'Researcher/Walkthroughs/walkthrough-distributed-training.md'
- 'Hyperparameter Optimization' : 'Researcher/Walkthroughs/walkthrough-hpo.md'
- 'Over-Quota, Basic Fairness & Bin-Packing' : 'Researcher/Walkthroughs/walkthrough-overquota.md'
- 'Queue Fairness' : 'Researcher/Walkthroughs/walkthrough-queue-fairness.md'
- 'Inference' : 'Researcher/Walkthroughs/quickstart-inference.md'
- 'Dynamic MIG' : 'Researcher/Walkthroughs/quickstart-mig.md'
- 'User Interface' :
- 'Workspaces' :
- 'Introduction' : 'Researcher/user-interface/workspaces/overview.md'
- 'Building Blocks' :
- 'Overview' : 'Researcher/user-interface/workspaces/blocks/building-blocks.md'
- 'Environments' : 'Researcher/user-interface/workspaces/blocks/environments.md'
- 'Compute Resources': 'Researcher/user-interface/workspaces/blocks/compute.md'
- 'Data Sources' : 'Researcher/user-interface/workspaces/blocks/datasources.md'
- 'Creation' :
- 'Environments' : 'Researcher/user-interface/workspaces/create/create-env.md'
- 'Compute Resources' : 'Researcher/user-interface/workspaces/create/create-compute.md'
- 'Data Sources' : 'Researcher/user-interface/workspaces/create/create-ds.md'
- 'Workspaces' : 'Researcher/user-interface/workspaces/create/workspace.md'
- 'Statuses' : 'Researcher/user-interface/workspaces/statuses.md'
- 'CLI Reference' :
- '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 resume' : 'Researcher/cli-reference/runai-resume.md'
- 'runai submit' : 'Researcher/cli-reference/runai-submit.md'
- 'runai submit-mpi' : 'Researcher/cli-reference/runai-submit-mpi.md'
- 'runai suspend' : 'Researcher/cli-reference/runai-suspend.md'
- 'runai top node' : 'Researcher/cli-reference/runai-top-node.md'
- 'runai top job' : 'Researcher/cli-reference/runai-top-job.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'
- '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'
- 'Job Statuses' : 'Researcher/scheduling/job-statuses.md'
- 'Scheduling Strategies' : 'Researcher/scheduling/strategies.md'
- 'Using Node Pools' : 'Researcher/scheduling/using-node-pools.md'
- 'Hyperparameter Optimization' : 'Researcher/scheduling/hpo.md'
- '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'
- 'API Authentication' : 'developer/rest-auth.md'
- 'Cluster API' :
- 'Workloads 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'
- 'Kubernetes Workloads' : 'developer/cluster-api/other-resources.md'
- 'Reference' :
- 'Training Workloads' : 'developer/cluster-api/reference/training.md'
- 'Interactive Workloads' : 'developer/cluster-api/reference/interactive.md'
- 'Inference Workloads' : 'developer/cluster-api/reference/inference.md'
- 'Administrator API' : 'developer/admin-rest-api/overview.md'
- 'Metrics API' :
- 'Metrics' : 'developer/metrics/metrics.md'
- 'Deprecated APIs' :
- 'Researcher API' :
- 'REST API' : 'developer/deprecated/researcher-rest-api/overview.md'
- 'Kubernetes API' :
- 'Overview' : 'developer/deprecated/k8s-api/overview.md'
- 'Submit a Job via YAML' : 'developer/deprecated/k8s-api/launch-job-via-yaml.md'
- 'Submit a Job via Kubernetes API' : 'developer/deprecated/k8s-api/launch-job-via-kubernetes-api.md'
- 'Inference API' :
- 'Overview' : 'developer/deprecated/inference/overview.md'
- 'Setup' : 'developer/deprecated/inference/setup.md'
- 'Submit via CLI' : 'developer/deprecated/inference/submit-via-cli.md'
You can’t perform that action at this time.