mirror of
https://github.com/vale981/ray
synced 2025-03-10 05:16:49 -04:00
8826646303
*This PR: Copies the existing clusters API reference to the new structure. The reference docs are split out into Ray Clusters (common between vms and k8s) and Ray Clusters on VMs (specific to vms). Notably, there is also a reference section for k8s, but not in this PR. Move the three job submission user guides back into a single one. Jules had suggested that we break them out into rest/sdk/cli, but that's not P0 right now. Fix some bugs in the left navigation bar. There should be less duplication of TOC entries. I'll keep working on related fixes in a different PR. Signed-off-by: Cade Daniel <cade@anyscale.com>
343 lines
16 KiB
YAML
343 lines
16 KiB
YAML
format: jb-book
|
|
root: index
|
|
parts:
|
|
- caption: Overview
|
|
chapters:
|
|
- file: ray-overview/index
|
|
- file: ray-overview/installation
|
|
- file: ray-overview/ray-libraries
|
|
|
|
- caption: Ray AI Runtime
|
|
chapters:
|
|
- file: ray-air/getting-started
|
|
title: "What is Ray AI Runtime (AIR)?"
|
|
- file: ray-air/key-concepts
|
|
- file: ray-air/user-guides
|
|
sections:
|
|
- file: ray-air/preprocessors
|
|
- file: ray-air/trainer
|
|
- file: ray-air/check-ingest
|
|
- file: ray-air/tuner
|
|
- file: ray-air/predictors
|
|
- file: ray-air/examples/serving_guide
|
|
- file: ray-air/deployment
|
|
- file: ray-air/examples/index
|
|
sections:
|
|
- file: ray-air/examples/torch_image_example
|
|
- file: ray-air/examples/convert_existing_pytorch_code_to_ray_air
|
|
- file: ray-air/examples/tfx_tabular_train_to_serve
|
|
- file: ray-air/examples/huggingface_text_classification
|
|
- file: ray-air/examples/sklearn_example
|
|
- file: ray-air/examples/xgboost_example
|
|
- file: ray-air/examples/analyze_tuning_results
|
|
- file: ray-air/examples/lightgbm_example
|
|
- file: ray-air/examples/torch_incremental_learning
|
|
- file: ray-air/examples/rl_serving_example
|
|
- file: ray-air/examples/rl_online_example
|
|
- file: ray-air/examples/rl_offline_example
|
|
- file: ray-air/examples/upload_to_comet_ml
|
|
- file: ray-air/examples/upload_to_wandb
|
|
- file: ray-air/examples/feast_example
|
|
- file: ray-air/package-ref
|
|
- file: ray-air/benchmarks
|
|
|
|
- caption: Ray Libraries
|
|
chapters:
|
|
- file: data/dataset
|
|
title: Ray Data
|
|
sections:
|
|
- file: data/getting-started
|
|
- file: data/key-concepts
|
|
- file: data/user-guide
|
|
- file: data/examples/index
|
|
sections:
|
|
- file: data/examples/nyc_taxi_basic_processing
|
|
title: Processing the NYC taxi dataset
|
|
- file: data/examples/big_data_ingestion
|
|
title: Large-scale ML Ingest
|
|
- file: data/examples/ocr_example
|
|
title: Scaling OCR with Ray Datasets
|
|
- file: data/advanced-pipelines
|
|
- file: data/random-access
|
|
- file: data/faq
|
|
- file: data/package-ref
|
|
- file: data/integrations
|
|
|
|
- file: train/train
|
|
title: Ray Train
|
|
sections:
|
|
- file: train/getting-started
|
|
- file: train/key-concepts
|
|
- file: train/user-guides
|
|
sections:
|
|
- file: train/config_guide
|
|
- file: train/dl_guide
|
|
- file: train/gbdt
|
|
- file: train/architecture
|
|
- file: train/faq
|
|
- file: train/examples
|
|
- file: train/api
|
|
|
|
- file: tune/index
|
|
title: Ray Tune
|
|
sections:
|
|
- file: tune/getting-started
|
|
- file: tune/key-concepts
|
|
- file: tune/tutorials/overview
|
|
sections:
|
|
- file: tune/tutorials/tune-lifecycle
|
|
title: "How Tune Works"
|
|
- file: tune/tutorials/tune-stopping
|
|
title: "How to Stop and Resume"
|
|
- file: tune/tutorials/tune-metrics
|
|
title: "Using Callbacks and Metrics"
|
|
- file: tune/tutorials/tune-distributed
|
|
title: "Distributed Tuning"
|
|
- file: tune/tutorials/tune-output
|
|
title: "Logging Tune Runs"
|
|
- file: tune/tutorials/tune-resources
|
|
title: "Managing Resources"
|
|
- file: tune/tutorials/tune-checkpoints
|
|
title: "Working with Checkpoints"
|
|
- file: tune/tutorials/tune-search-spaces
|
|
title: "Using Search Spaces"
|
|
- file: tune/tutorials/tune-advanced-tutorial
|
|
title: "Understanding PBT"
|
|
- file: tune/tutorials/tune-scalability
|
|
title: "Scalability Benchmarks"
|
|
- file: tune/examples/index
|
|
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/mxnet_example
|
|
title: "MXNet 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: "Huggingface Example"
|
|
- file: tune/examples/tune-comet
|
|
title: "Comet Example"
|
|
- file: tune/examples/tune-wandb
|
|
title: "Weights & Biases Example"
|
|
- file: tune/examples/ax_example
|
|
title: "Ax Example"
|
|
- file: tune/examples/dragonfly_example
|
|
title: "Dragonfly Example"
|
|
- file: tune/examples/skopt_example
|
|
title: "Skopt 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/zoopt_example
|
|
title: "ZOOpt Example"
|
|
- file: tune/examples/sigopt_example
|
|
title: "SigOpt Example"
|
|
- file: tune/examples/hebo_example
|
|
title: "HEBO Example"
|
|
|
|
- file: tune/faq
|
|
- file: tune/api_docs/overview.rst
|
|
|
|
- file: serve/index
|
|
title: Ray Serve
|
|
sections:
|
|
- file: serve/getting_started
|
|
- file: serve/key-concepts
|
|
- file: serve/user-guide
|
|
sections:
|
|
- file: serve/managing-deployments
|
|
- file: serve/handling-dependencies
|
|
- file: serve/http-guide
|
|
- file: serve/handle-guide
|
|
- file: serve/ml-models
|
|
- file: serve/model_composition
|
|
- file: serve/deploying-serve
|
|
- file: serve/monitoring
|
|
- file: serve/performance
|
|
- file: serve/autoscaling
|
|
- file: serve/production
|
|
- file: serve/migration
|
|
- 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/faq
|
|
- file: serve/package-ref
|
|
|
|
- file: rllib/index
|
|
title: Ray RLlib
|
|
sections:
|
|
- file: rllib/core-concepts
|
|
- file: rllib/rllib-training
|
|
- file: rllib/rllib-env
|
|
- file: rllib/rllib-algorithms
|
|
- file: rllib/user-guides
|
|
sections:
|
|
- file: rllib/rllib-models
|
|
- file: rllib/rllib-concepts
|
|
- file: rllib/rllib-sample-collection
|
|
- file: rllib/rllib-replay-buffers
|
|
- file: rllib/rllib-offline
|
|
- file: rllib/rllib-dev
|
|
- 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/ray-lightning
|
|
- file: ray-core/examples/using-ray-with-pytorch-lightning
|
|
- file: ray-core/examples/dask_xgboost/dask_xgboost
|
|
- file: ray-core/examples/modin_xgboost/modin_xgboost
|
|
- file: workflows/concepts
|
|
title: Ray Workflows
|
|
sections:
|
|
- file: workflows/basics
|
|
- file: workflows/management
|
|
- file: workflows/metadata
|
|
- file: workflows/events
|
|
- file: workflows/comparison
|
|
- file: workflows/advanced
|
|
- file: workflows/package-ref
|
|
|
|
- caption: Ray Core
|
|
chapters:
|
|
- file: ray-core/walkthrough
|
|
title: Getting Started
|
|
- 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/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/package-ref
|
|
|
|
- caption: Ray Clusters
|
|
chapters:
|
|
- file: cluster/index
|
|
- file: cluster/quickstart
|
|
- file: cluster/key-concepts
|
|
- file: cluster/user-guide
|
|
- file: cluster/cloud
|
|
- file: cluster/deploy
|
|
- file: cluster/api
|
|
- file: cluster/usage-stats
|
|
- file: cluster/cluster_under_construction
|
|
title: Ray Clusters (under construction)
|
|
sections:
|
|
- file: cluster/cluster_under_construction/getting-started
|
|
title: Getting Started
|
|
- file: cluster/cluster_under_construction/key-concepts
|
|
title: Key Concepts
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/index
|
|
title: Ray Clusters on Kubernetes
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/getting-started
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/k8s-cluster-setup.md
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/config.md
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/autoscaling.md
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/logging.md
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/gpu.md
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/kuberay-vs-legacy.md
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/examples
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/examples/ml-example.md
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/references
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/index
|
|
title: Ray Clusters on VMs
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/getting-started
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/index
|
|
title: User Guides
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/installing-ray
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/launching-clusters/index
|
|
title: Launching Clusters
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/running-ray-cluster-on-prem
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/monitoring-and-observing-ray-cluster
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/large-cluster-best-practices
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/multi-tenancy-best-practices
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/configuring-autoscaling
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/community-supported-cluster-manager/index
|
|
title: Community-supported Cluster Managers
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/community-supported-cluster-manager/yarn
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/community-supported-cluster-manager/slurm
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/community-supported-cluster-manager/lsf
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/running-jobs/index
|
|
title: Running Jobs
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/index
|
|
title: Examples
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/learn-ray-cluster-basics/index
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/learn-ray-cluster-basics/launching-ray-cluster
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/learn-ray-cluster-basics/running-job-via-job-submission
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/learn-ray-cluster-basics/scale-your-job-with-autoscaling
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/learn-ray-cluster-basics/observe-your-app
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/learn-ray-cluster-basics/shutting-down-your-ray-cluster
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/setting-up-ray-cluster-for-development/index
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/setting-up-ray-cluster-for-development/todo
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/setting-up-ray-cluster-for-production/index
|
|
sections:
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/examples/setting-up-ray-cluster-for-production/todo
|
|
- file: cluster/cluster_under_construction/ray-clusters-on-vms/references/index
|
|
- file: cluster/cluster_under_construction/references/index
|
|
title: References
|
|
|
|
- caption: References
|
|
chapters:
|
|
- file: ray-references/api
|
|
|
|
- caption: Developer Guides
|
|
chapters:
|
|
- file: ray-contribute/stability
|
|
- file: ray-contribute/getting-involved
|
|
sections:
|
|
- file: ray-contribute/development
|
|
- file: ray-contribute/docs
|
|
- file: ray-contribute/fake-autoscaler
|
|
- file: ray-core/examples/testing-tips
|
|
- file: ray-core/configure
|
|
- file: ray-observability/index
|
|
- file: ray-contribute/whitepaper
|