ray/doc/source
Matti Picus 442943572b
DOC, BUILD: limit bazel resource usage with BAZEL_LIMIT_CPUS and document it (#20845)
So I have a AMD machine with many cores and 32GB of memory. When I do `pip install -e .`, my machine crashes since bazel tries to use all the cores, but quickly runs out of memory. It seems there is no native way to set environment variables to tell bazel to limit its resource consumption, but there is a `--local_cpu_resources` command-line option.

This PR exposes that to the `pip install` via an environment variable. I also went through the setup.py and documented all the environment variables I could find.
2021-12-02 16:39:36 -08:00
..
_static [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
_templates [Docs] Trial Fathom analytics for doc pages (#17056) 2021-07-14 14:11:52 -07:00
cluster [docs] autoscaler/K8s hiring roles (#20621) 2021-11-23 14:56:22 -08:00
data [Datasets] Last-mile preprocessing docs. (#20712) 2021-11-29 23:23:27 -08:00
images [RLlib; Docs] Auto API reference pages overhaul: rllib/policy and rllib/agents packages. (#20537) 2021-11-25 09:35:19 +01:00
ray-design-patterns [docs] Add ray desig patterns and antipatterns to docs (#16478) 2021-06-17 19:56:44 +01:00
ray-job-submission [docs][job submission] Fixed minor editorial nits (#20654) 2021-11-22 22:06:31 -06:00
ray-overview [RLlib; Documentation] RLlib README overhaul. (#20249) 2021-11-18 18:08:40 +01:00
raysgd Added example to user guide for cloud checkpointing (#20045) 2021-11-15 15:43:06 +00:00
rllib [RLlib; Docs] Auto API reference pages overhaul: rllib/policy and rllib/agents packages. (#20537) 2021-11-25 09:35:19 +01:00
serve [Serve] [Doc] fix custom metric link in serve doc (#20775) 2021-12-01 16:39:22 -07:00
train [Train] Minor migration guide update (#20683) 2021-11-29 12:42:28 -08:00
tune [tune] Introduce TrialCheckpoint class, making checkpoint down/upload easie (#20585) 2021-11-22 14:16:26 +00:00
workflows [workflow] workflow.wait() feature (#20163) 2021-11-30 12:30:28 -08:00
_help.rst [docs] redirect to discourse (#12427) 2020-11-25 17:10:10 -08:00
a2c-arch.svg [rllib] [docs] Add some architecture diagrams (#5390) 2019-08-06 20:14:57 -07:00
actors.rst [runtime env] [Doc] Add concepts and basic workflows (#20222) 2021-11-19 13:58:50 -08:00
advanced.rst [Doc] [runtime env] Move runtime env section up one level, add inbound links (#19863) 2021-10-29 12:02:39 -05:00
apex-arch.svg [rllib] [docs] Add some architecture diagrams (#5390) 2019-08-06 20:14:57 -07:00
apex.png [rllib] Document "v2" APIs (#2316) 2018-07-01 00:05:08 -07:00
async_api.rst [Core] Add concurrent.futures.Future wrapper for ObjectRef (#15425) 2021-04-23 11:53:46 -05:00
concurrency_group_api.rst [Core] Port concurrency groups with asyncio (#18567) 2021-10-21 21:46:56 +08:00
conf.py [Core][Pubsub][Logging 1/n] add logging support to GCS pubsub in Python (#20604) 2021-11-29 11:26:01 -08:00
configure.rst [DOC] Add namespace doc for Java part. (#20428) 2021-11-17 23:02:47 +08:00
cross-language.rst [Doc] [runtime env] Move runtime env section up one level, add inbound links (#19863) 2021-10-29 12:02:39 -05:00
custom_directives.py Fix XGBoost-Ray and LightGBM-Ray docs properly (#17433) 2021-07-30 15:47:41 +01:00
custom_metric.png [rllib] Implement custom metrics (#3144) 2018-11-03 18:48:32 -07:00
ddppo-arch.svg [rllib] Add Decentralized DDPPO trainer and documentation (#7088) 2020-02-10 15:28:27 -08:00
debugging.rst Update the contribution guide / style guide (#18753) 2021-09-19 20:14:51 -07:00
development.rst DOC, BUILD: limit bazel resource usage with BAZEL_LIMIT_CPUS and document it (#20845) 2021-12-02 16:39:36 -08:00
download_zip_url.png [runtime_env][docs] Add documentation on using remote URIs for runtime environments (#20352) 2021-11-17 23:17:48 -06:00
dqn-arch.svg [rllib] [docs] Add some architecture diagrams (#5390) 2019-08-06 20:14:57 -07:00
es.png [rllib] Document "v2" APIs (#2316) 2018-07-01 00:05:08 -07:00
fake-autoscaler.rst [autoscaler] Use drain node api in autoscaler before terminating nodes (#20013) 2021-11-11 08:31:40 -08:00
fault-tolerance.rst [Core][actor out-of-order execution 6/n] plumbing work to make it work e2e (#20177) 2021-11-19 11:05:18 -08:00
getting-involved.rst [Doc] Move all contribution info to getting-involved.html and link to it from CONTRIBUTING.rst (#19571) 2021-10-25 14:23:23 -05:00
handling-dependencies.rst [runtime env] [Doc] Add concepts and basic workflows (#20222) 2021-11-19 13:58:50 -08:00
impala-arch.svg [rllib] [docs] Add some architecture diagrams (#5390) 2019-08-06 20:14:57 -07:00
impala.png [rllib] Update multi-gpu impala numbers (#3327) 2018-11-19 20:55:27 -08:00
index.rst [Datasets] Last-mile preprocessing docs. (#20712) 2021-11-29 23:23:27 -08:00
installation.rst Revert "Revert "[Docs] More detailed M1 Mac installation instructions"" (#20549) 2021-11-18 20:18:37 -08:00
joblib.rst [docs] Fix dead links to cluster docs by making dashes slashes (#12260) 2020-11-23 12:52:36 -08:00
lightgbm-ray.rst Added example to user guide for cloud checkpointing (#20045) 2021-11-15 15:43:06 +00:00
memory-management.rst Add feature flag for plasma overcommit (#16061) 2021-05-26 10:53:57 -07:00
MemoryTrackingCallbacks.png [RLlib] Memory leak docs (#15908) 2021-06-10 18:10:21 +02:00
multi-agent.svg [rllib] Document "v2" APIs (#2316) 2018-07-01 00:05:08 -07:00
multi-flat.svg [rllib] RLlib in 60 seconds documentation (#5430) 2019-08-12 17:39:02 -07:00
multiprocessing.rst [docs] Remove API warning from mp.Pool (#13683) 2021-01-25 09:59:46 -08:00
namespaces.rst [DOC] Add namespace doc for Java part. (#20428) 2021-11-17 23:02:47 +08:00
offline-q.png [rllib] Basic infrastructure for off-policy estimation (IS, WIS) (#3941) 2019-02-13 16:25:05 -08:00
package-ref.rst [RFC] API stability annotations (#17100) 2021-07-16 17:09:20 -07:00
pbt.png [tune] Improve PBT example (#4575) 2019-04-09 20:59:17 -07:00
placement-group.rst [Docs] Fix typo in C++ Placement Group example (#20386) 2021-11-16 08:19:09 +09:00
ppo-arch.svg [rllib] [docs] Add some architecture diagrams (#5390) 2019-08-06 20:14:57 -07:00
ppo.png [rllib] Document "v2" APIs (#2316) 2018-07-01 00:05:08 -07:00
profiling.rst [Nightly Test] Support memory profiling on Ray + implement memory monitor for nightly tests (#19539) 2021-10-21 07:37:05 -07:00
pytorch.png [rllib] Add TF and Torch icons to show which are available for each algo (#6869) 2020-01-20 15:22:21 -08:00
ray-collective.rst [Collective] generate ray.util.collective doc (#16521) 2021-06-17 18:41:57 -07:00
ray-dashboard.rst [Documentation] Fix quotes for windows installations (#19859) 2021-10-29 10:54:38 -07:00
ray-debugging.rst [serve] Modify serve debugger example to use current APIs (#19513) 2021-10-19 13:21:56 -07:00
ray-libraries.rst [doc] Bump dataset to beta for 1.8 and add backlink to SGD (#19332) 2021-10-12 18:32:29 -07:00
ray-lightning.rst Added example to user guide for cloud checkpointing (#20045) 2021-11-15 15:43:06 +00:00
ray-logging.rst [metrics] Improve custom metrics docs, add an example on how to use them (#14690) 2021-03-15 17:37:02 -05:00
ray-metrics.rst [Serve] [Doc] fix custom metric link in serve doc (#20775) 2021-12-01 16:39:22 -07:00
ray-tracing.rst Update versioning for tracing in Ray docs (#16041) 2021-06-08 19:23:19 -07:00
ray-tune-parcoords.png [tune] Fix Docs (#1469) 2018-01-25 16:39:00 -08:00
ray-tune-tensorboard.png [tune] Documentation for Ray.tune (#1243) 2017-11-23 11:31:59 -08:00
ray-tune-viskit.png [tune] Documentation for Ray.tune (#1243) 2017-11-23 11:31:59 -08:00
ray_repo.png [runtime_env][docs] Add documentation on using remote URIs for runtime environments (#20352) 2021-11-17 23:17:48 -06:00
rllib-algorithms.rst Revert "Revert [RLlib] POC: PGTrainer class that works by sub-classing, not trainer_template.py." (#20285) 2021-11-16 12:26:47 +01:00
rllib-api.svg [rllib] Add rock paper scissors multi-agent example (#5336) 2019-08-01 13:03:59 -07:00
rllib-components.svg [rllib] Adds eager support with a generic TFEagerPolicy class (#5436) 2019-08-23 14:21:11 +08:00
rllib-concepts.rst [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
rllib-config.svg [rllib] Rename sample_batch_size => rollout_fragment_length (#7503) 2020-03-14 12:05:04 -07:00
rllib-dev.rst [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
rllib-env.rst [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
rllib-envs.svg [rllib] annotate public vs developer vs private APIs (#3808) 2019-01-23 21:27:26 -08:00
rllib-examples.rst [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
rllib-external.svg [rllib] Add high-performance external application connector (#7641) 2020-03-20 12:43:57 -07:00
rllib-models.rst [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
rllib-offline.rst [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
rllib-package-ref.rst [RLlib; Docs] Auto API reference pages overhaul: rllib/policy and rllib/agents packages. (#20537) 2021-11-25 09:35:19 +01:00
rllib-sample-collection.rst [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
rllib-stack.svg [rllib] Sync filters at end of iteration not start; hierarchical docs (#3769) 2019-01-15 16:25:25 -08:00
rllib-toc.rst [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
rllib-training.rst [RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
rock-paper-scissors.png [rllib] Add rock paper scissors multi-agent example (#5336) 2019-08-01 13:03:59 -07:00
serialization.rst [Serialization] API for deregistering serializers; code & doc cleanup (#13471) 2021-01-29 10:27:05 -08:00
sgd.png [sgd] Document and add simple MNIST example (#3236) 2018-11-10 21:52:20 -08:00
starting-ray.rst [C++ API] add C++ API docs (#17743) 2021-08-12 22:40:09 +08:00
struct-tensor.png [rllib] Support for complex / variable-length observation spaces (#8393) 2020-06-06 12:22:19 +02:00
tensorflow.png [rllib] Add TF and Torch icons to show which are available for each algo (#6869) 2020-01-20 15:22:21 -08:00
throughput.png [rllib] Document "v2" APIs (#2316) 2018-07-01 00:05:08 -07:00
timeline.png [minor] Use a better timeline pic in the documentation 2017-12-20 12:54:25 -08:00
troubleshooting.rst [core][usability] Disambiguate ObjectLostErrors for better understandability (#18292) 2021-09-13 16:16:17 -07:00
using-ray-with-gpus.rst [api] Initial API deprecations for Ray 1.0 (#10325) 2020-08-28 15:03:50 -07:00
using-ray-with-jupyter.rst [docs] Add best practices for Jupyter Notebook (#16798) 2021-07-01 18:34:29 -07:00
using-ray-with-pytorch.rst [docs] Second push of changes (#5391) 2019-08-28 17:54:15 -07:00
using-ray-with-tensorflow.rst [tune] Put examples under proper version control (#9427) 2020-07-13 18:01:10 -07:00
using-ray.rst [runtime env] [Doc] Add concepts and basic workflows (#20222) 2021-11-19 13:58:50 -08:00
walkthrough.rst [runtime env] [Doc] Add concepts and basic workflows (#20222) 2021-11-19 13:58:50 -08:00
whitepaper.rst [docs] Add links to Ray design patterns whitepaper (#12014) 2020-11-13 14:16:51 -08:00
xgboost-ray.rst Added example to user guide for cloud checkpointing (#20045) 2021-11-15 15:43:06 +00:00