forked from ray-project/ray
-
Notifications
You must be signed in to change notification settings - Fork 0
/
_toc.yml
408 lines (396 loc) · 18 KB
/
_toc.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
format: jb-book
root: index
parts:
- caption: Ray
chapters:
- file: ray-overview/index
title: "Overview"
- file: ray-overview/getting-started
title: "Getting Started"
- file: ray-overview/installation
title: "Installation"
- file: ray-overview/use-cases
title: "Use Cases"
sections:
- file: ray-air/getting-started
- file: ray-overview/examples
title: "Example Gallery"
- file: ray-overview/ray-libraries
title: "Ecosystem"
- file: ray-core/walkthrough
title: "Ray Core"
sections:
- file: ray-core/key-concepts
title: "Key Concepts"
- file: ray-core/user-guide
title: "User Guides"
- file: ray-core/examples/overview
title: "Examples"
sections:
- file: ray-core/examples/gentle_walkthrough
- file: ray-core/examples/monte_carlo_pi
- file: ray-core/examples/plot_example-a3c
- file: ray-core/examples/plot_example-lm
- file: ray-core/examples/plot_hyperparameter
- file: ray-core/examples/plot_parameter_server
- file: ray-core/examples/plot_pong_example
- file: ray-core/examples/highly_parallel
- file: ray-core/examples/batch_prediction
- file: ray-core/examples/batch_training
- file: ray-core/examples/automl_for_time_series
- file: ray-core/examples/web-crawler
- file: ray-core/examples/map_reduce
- file: ray-core/api/index
- file: data/data
title: Ray Data
sections:
- file: data/overview
title: Overview
- file: data/key-concepts
- file: data/user-guide
- file: data/examples/index
- file: data/api/api
- file: data/data-internals
- file: train/train
title: Ray Train
sections:
- file: train/key-concepts
title: Key Concepts
- file: train/getting-started-pytorch
title: PyTorch Guide
- file: train/getting-started-pytorch-lightning
title: PyTorch Lightning Guide
- file: train/getting-started-transformers
title: Hugging Face Transformers Guide
- file: train/more-frameworks
sections:
- file: train/huggingface-accelerate
title: Hugging Face Accelerate Guide
- file: train/deepspeed
title: DeepSpeed Guide
- file: train/distributed-tensorflow-keras
title: TensorFlow and Keras Guide
- file: train/distributed-xgboost-lightgbm
title: XGBoost and LightGBM Guide
- file: train/horovod
title: Horovod Guide
- file: train/user-guides
title: User Guides
- file: train/examples
title: "Examples"
- file: train/benchmarks
title: "Benchmarks"
- file: train/api/api
- file: tune/index
title: Ray Tune
sections:
- file: tune/getting-started
title: "Getting Started"
- file: tune/key-concepts
title: "Key Concepts"
- file: tune/tutorials/overview
sections:
- file: tune/tutorials/tune-run
title: "Running Basic Experiments"
- file: tune/tutorials/tune-output
- file: tune/tutorials/tune-resources
title: "Setting Trial Resources"
- file: tune/tutorials/tune-search-spaces
title: "Using Search Spaces"
- file: tune/tutorials/tune-stopping
- file: tune/tutorials/tune-trial-checkpoints
- file: tune/tutorials/tune-storage
- file: tune/tutorials/tune-fault-tolerance
- file: tune/tutorials/tune-metrics
title: "Using Callbacks and Metrics"
- file: tune/tutorials/tune_get_data_in_and_out
- file: tune/examples/tune_analyze_results
- file: tune/examples/pbt_guide
sections:
- file: tune/examples/pbt_visualization/pbt_visualization
title: "Visualizing and Understanding PBT"
- file: tune/tutorials/tune-distributed
title: "Deploying Tune in the Cloud"
- file: tune/tutorials/tune-lifecycle
title: "Tune Architecture"
- file: tune/tutorials/tune-scalability
title: "Scalability Benchmarks"
- file: tune/examples/index
sections:
- file: tune/examples/ml-frameworks
sections:
- file: tune/examples/tune-sklearn
title: "Scikit-Learn Example"
- file: tune/examples/tune_mnist_keras
title: "Keras Example"
- file: tune/examples/tune-pytorch-cifar
title: "PyTorch Example"
- file: tune/examples/tune-pytorch-lightning
title: "PyTorch Lightning Example"
- file: tune/examples/tune-serve-integration-mnist
title: "Ray Serve Example"
- file: tune/examples/pbt_ppo_example
title: "Ray RLlib Example"
- file: tune/examples/tune-xgboost
title: "XGBoost Example"
- file: tune/examples/lightgbm_example
title: "LightGBM Example"
- file: tune/examples/horovod_simple
title: "Horovod Example"
- file: tune/examples/pbt_transformers
title: "Hugging Face Transformers Example"
- file: tune/examples/experiment-tracking
sections:
- file: tune/examples/tune-wandb
title: "Weights & Biases Example"
- file: tune/examples/tune-mlflow
title: "MLflow Example"
- file: tune/examples/tune-aim
title: "Aim Example"
- file: tune/examples/tune-comet
title: "Comet Example"
- file: tune/examples/hpo-frameworks
sections:
- file: tune/examples/ax_example
title: "Ax Example"
- file: tune/examples/dragonfly_example
title: "Dragonfly Example"
- file: tune/examples/hyperopt_example
title: "HyperOpt Example"
- file: tune/examples/bayesopt_example
title: "Bayesopt Example"
- file: tune/examples/flaml_example
title: "FLAML Example"
- file: tune/examples/bohb_example
title: "BOHB Example"
- file: tune/examples/nevergrad_example
title: "Nevergrad Example"
- file: tune/examples/optuna_example
title: "Optuna Example"
- file: tune/examples/sigopt_example
title: "SigOpt Example"
- file: tune/examples/other-examples
title: "Other Examples"
- file: tune/examples/exercises
title: "Exercises"
- file: tune/faq
- file: tune/api/api.rst
- file: serve/index
title: Ray Serve
sections:
- file: serve/getting_started
- file: serve/key-concepts
- file: serve/develop-and-deploy
- file: serve/model_composition
- file: serve/deploy-many-models/index
sections:
- file: serve/deploy-many-models/multi-app
- file: serve/deploy-many-models/model-multiplexing
- file: serve/configure-serve-deployment
- file: serve/http-guide
- file: serve/production-guide/index
title: Production Guide
sections:
- file: serve/production-guide/config
- file: serve/production-guide/kubernetes
- file: serve/production-guide/docker
- file: serve/production-guide/fault-tolerance
- file: serve/production-guide/handling-dependencies
- file: serve/production-guide/best-practices
- file: serve/monitoring
- file: serve/scaling-and-resource-allocation
- file: serve/advanced-guides/index
sections:
- file: serve/advanced-guides/app-builder-guide
- file: serve/advanced-guides/performance
- file: serve/advanced-guides/dyn-req-batch
- file: serve/advanced-guides/inplace-updates
- file: serve/advanced-guides/dev-workflow
- file: serve/advanced-guides/deployment-graphs
- file: serve/advanced-guides/direct-ingress
- file: serve/advanced-guides/managing-java-deployments
- file: serve/advanced-guides/migration
- file: serve/advanced-guides/deploy-vm
- file: serve/architecture
- file: serve/tutorials/index
sections:
- file: serve/tutorials/deployment-graph-patterns
sections:
- file: serve/tutorials/deployment-graph-patterns/linear_pipeline
- file: serve/tutorials/deployment-graph-patterns/branching_input
- file: serve/tutorials/deployment-graph-patterns/conditional
- file: serve/api/index
- file: rllib/index
title: Ray RLlib
sections:
- file: rllib/rllib-training
- file: rllib/key-concepts
- file: rllib/rllib-env
- file: rllib/rllib-algorithms
- file: rllib/user-guides
sections:
- file: rllib/rllib-advanced-api
- file: rllib/rllib-models
- file: rllib/rllib-saving-and-loading-algos-and-policies
- file: rllib/rllib-concepts
- file: rllib/rllib-sample-collection
- file: rllib/rllib-replay-buffers
- file: rllib/rllib-offline
- file: rllib/rllib-catalogs
- file: rllib/rllib-connector
- file: rllib/rllib-rlmodule
- file: rllib/rllib-learner
- file: rllib/rllib-torch2x
- file: rllib/rllib-fault-tolerance
- file: rllib/rllib-dev
- file: rllib/rllib-cli
- file: rllib/rllib-examples
- file: rllib/package_ref/index
- file: ray-more-libs/index
title: More Libraries
sections:
- file: ray-more-libs/joblib
- file: ray-more-libs/multiprocessing
- file: ray-more-libs/ray-collective
- file: ray-more-libs/dask-on-ray
- file: ray-more-libs/raydp
- file: ray-more-libs/mars-on-ray
- file: ray-more-libs/modin/index
- file: workflows/index
title: Ray Workflows (Alpha)
sections:
- file: workflows/key-concepts
- file: workflows/basics
- file: workflows/management
- file: workflows/metadata
- file: workflows/events
- file: workflows/comparison
- file: workflows/advanced
- file: workflows/api/api
- file: cluster/getting-started
title: "Ray Clusters"
sections:
- file: cluster/key-concepts
title: Key Concepts
- file: cluster/kubernetes/index
title: Deploying on Kubernetes
sections:
- file: cluster/kubernetes/getting-started
sections:
- file: cluster/kubernetes/getting-started/raycluster-quick-start.md
- file: cluster/kubernetes/getting-started/rayjob-quick-start.md
- file: cluster/kubernetes/getting-started/rayservice-quick-start.md
- file: cluster/kubernetes/user-guides
sections:
- file: cluster/kubernetes/user-guides/rayservice.md
- file: cluster/kubernetes/user-guides/observability.md
- file: cluster/kubernetes/user-guides/k8s-cluster-setup.md
sections:
- file: cluster/kubernetes/user-guides/aws-eks-gpu-cluster.md
- file: cluster/kubernetes/user-guides/gcp-gke-gpu-cluster.md
- file: cluster/kubernetes/user-guides/config.md
- file: cluster/kubernetes/user-guides/configuring-autoscaling.md
- file: cluster/kubernetes/user-guides/gke-gcs-bucket.md
- file: cluster/kubernetes/user-guides/logging.md
- file: cluster/kubernetes/user-guides/gpu.md
- file: cluster/kubernetes/user-guides/rayserve-dev-doc.md
- file: cluster/kubernetes/user-guides/experimental.md
- file: cluster/kubernetes/user-guides/pod-command.md
- file: cluster/kubernetes/user-guides/pod-security.md
- file: cluster/kubernetes/user-guides/tls.md
- file: cluster/kubernetes/user-guides/static-ray-cluster-without-kuberay.md
- file: cluster/kubernetes/examples
sections:
- file: cluster/kubernetes/examples/ml-example.md
- file: cluster/kubernetes/examples/gpu-training-example.md
- file: cluster/kubernetes/examples/stable-diffusion-rayservice.md
- file: cluster/kubernetes/examples/mobilenet-rayservice.md
- file: cluster/kubernetes/examples/text-summarizer-rayservice.md
- file: cluster/kubernetes/k8s-ecosystem
sections:
- file: cluster/kubernetes/k8s-ecosystem/ingress.md
- file: cluster/kubernetes/k8s-ecosystem/prometheus-grafana.md
- file: cluster/kubernetes/k8s-ecosystem/pyspy.md
- file: cluster/kubernetes/k8s-ecosystem/kubeflow.md
- file: cluster/kubernetes/benchmarks
sections:
- file: cluster/kubernetes/benchmarks/memory-scalability-benchmark.md
- file: cluster/kubernetes/troubleshooting
sections:
- file: cluster/kubernetes/troubleshooting/troubleshooting.md
- file: cluster/kubernetes/troubleshooting/rayservice-troubleshooting.md
- file: cluster/kubernetes/references
- file: cluster/vms/index
title: Deploying on VMs
sections:
- file: cluster/vms/getting-started
- file: cluster/vms/user-guides/index
title: User Guides
sections:
- file: cluster/vms/user-guides/launching-clusters/index
- file: cluster/vms/user-guides/large-cluster-best-practices
- file: cluster/vms/user-guides/configuring-autoscaling
- file: cluster/vms/user-guides/logging
- file: cluster/vms/user-guides/community/index
title: Community-supported Cluster Managers
sections:
- file: cluster/vms/user-guides/community/yarn
- file: cluster/vms/user-guides/community/slurm
- file: cluster/vms/user-guides/community/lsf
- file: cluster/vms/examples/index
title: Examples
sections:
- file: cluster/vms/examples/ml-example
- file: cluster/vms/references/index
- file: cluster/metrics
- file: cluster/configure-manage-dashboard
- file: cluster/running-applications/index
title: Applications Guide
- file: cluster/faq
- file: cluster/package-overview
- file: ray-observability/index
title: "Monitoring and Debugging"
sections:
- file: ray-observability/getting-started
- file: ray-observability/key-concepts
- file: ray-observability/user-guides/index
title: User Guides
sections:
- file: ray-observability/user-guides/debug-apps/index
title: Debugging Applications
sections:
- file: ray-observability/user-guides/debug-apps/general-debugging
- file: ray-observability/user-guides/debug-apps/debug-memory
- file: ray-observability/user-guides/debug-apps/debug-hangs
- file: ray-observability/user-guides/debug-apps/debug-failures
- file: ray-observability/user-guides/debug-apps/optimize-performance
- file: ray-observability/user-guides/debug-apps/ray-debugging
- file: ray-observability/user-guides/cli-sdk
- file: ray-observability/user-guides/configure-logging
- file: ray-observability/user-guides/add-app-metrics
- file: ray-observability/user-guides/ray-tracing
- file: ray-observability/reference/index
title: Reference
sections:
- file: ray-observability/reference/api
- file: ray-observability/reference/cli
- file: ray-observability/reference/system-metrics
- file: ray-references/api
title: References
sections:
- file: cluster/usage-stats
- file: ray-references/glossary
- file: ray-contribute/stability
title: Developer Guides
sections:
- file: ray-contribute/getting-involved
sections:
- file: ray-contribute/development
- file: ray-contribute/docs
- file: ray-contribute/writing-code-snippets
- file: ray-contribute/fake-autoscaler
- file: ray-core/examples/testing-tips
- file: ray-contribute/debugging.rst
- file: ray-contribute/profiling.rst
- file: ray-core/configure
- file: ray-contribute/whitepaper