Richard Liaw f2faf5ce75 [tune] Contributor Guide and Design Page (#4716) ...

* Move setup script out

* some changes

* Finished Contributor guide

* some comments to the design

* move

* Apply suggestions from code review

Co-Authored-By: richardliaw <rliaw@berkeley.edu>

* sourcecode

* comments

2019-05-05 00:04:13 -07:00

..

_static

Move documentation to ReadTheDocs. (#326)

2017-02-27 21:14:31 -08:00

_templates

Add better analytics to docs (#1854)

2018-04-10 00:51:44 -07:00

images

[tune] Contributor Guide and Design Page (#4716)

2019-05-05 00:04:13 -07:00

actors.rst

Remove local/global_scheduler from code and doc. (#4549)

2019-04-03 17:05:09 -07:00

apex.png

[rllib] Document "v2" APIs (#2316)

2018-07-01 00:05:08 -07:00

api.rst

Add "ray timeline" command to auto-dump Chrome trace for the current Ray instance (#4239)

2019-03-05 16:28:00 -08:00

async_api.rst

Experimental asyncio support (#2015)

2018-12-06 17:39:05 -08:00

autoscaler-status.png

Update the pip wheel in example.yaml and add docs (#1381)

2018-01-01 13:02:05 -08:00

autoscaling.rst

Direct people to stackoverflow for questions about usage. (#3830)

2019-01-23 13:30:02 -08:00

conf.py

[docs] Show source code (#3281)

2019-04-03 21:30:20 -07:00

contact.rst

Direct people to stackoverflow for questions about usage. (#3830)

2019-01-23 13:30:02 -08:00

custom_metric.png

[rllib] Implement custom metrics (#3144)

2018-11-03 18:48:32 -07:00

deploy-on-kubernetes.rst

Fix linting on master (#3913)

2019-01-31 01:28:45 -08:00

development.rst

Updated test script paths in documentation (#4170)

2019-02-26 16:14:55 -08:00

distributed_sgd.rst

[sgd] Modify: add interface for model (#3458)

2018-12-12 21:23:25 -08:00

es.png

[rllib] Document "v2" APIs (#2316)

2018-07-01 00:05:08 -07:00

example-a3c.rst

Make Bazel the default build system (#3898)

2019-02-23 11:58:59 -08:00

example-cython.rst

Replace python setup.py install with pip install -e . (#1460)

2018-02-22 11:15:03 -08:00

example-evolution-strategies.rst

[rllib] Remove uses of sgd_stepsize => lr (#3667)

2019-01-01 12:01:27 +08:00

example-lbfgs.rst

Change Python examples in documentation to use 4 space indentation. (#736)

2017-07-16 22:19:33 -07:00

example-newsreader.rst

Add initial news reader example (#4348)

2019-03-20 18:47:12 -07:00

example-parameter-server.rst

[doc] Update example-parameter-server.rst (#3773)

2019-02-05 22:00:54 -08:00

example-policy-gradient.rst

[docs] Switch docs to use rllib train instead of train.py

2018-12-04 17:36:06 -08:00

example-resnet.rst

Allow ResNet example to run on multiple machines. (#891)

2017-08-29 21:37:53 -07:00

example-rl-pong.rst

Change Python examples in documentation to use 4 space indentation. (#736)

2017-07-16 22:19:33 -07:00

example-streaming.rst

Add streaming MapReduce example (#1251)

2017-11-27 21:38:35 -08:00

fault-tolerance.rst

Update actor fault tolerance documentation. (#3175)

2018-11-01 11:52:05 -07:00

impala.png

[rllib] Update multi-gpu impala numbers (#3327)

2018-11-19 20:55:27 -08:00

index.rst

[tune] Contributor Guide and Design Page (#4716)

2019-05-05 00:04:13 -07:00

install-on-docker.rst

[doc] Replace runtest.py with mini_test.py in documentation. (#3750)

2019-01-12 14:05:28 -08:00

installation-troubleshooting.rst

Remove CMake files (#4493)

2019-04-02 22:17:33 -07:00

installation.rst

[doc] Remove instructions for installing Python2 for webui. (#4740)

2019-05-02 22:35:23 -07:00

internals-overview.rst

Remove local/global_scheduler from code and doc. (#4549)

2019-04-03 17:05:09 -07:00

multi-agent.svg

[rllib] Document "v2" APIs (#2316)

2018-07-01 00:05:08 -07:00

offline-q.png

[rllib] Basic infrastructure for off-policy estimation (IS, WIS) (#3941)

2019-02-13 16:25:05 -08:00

pandas_on_ray.rst

Dataframe deprecation (#2353)

2018-07-06 00:16:22 -07:00

pbt.png

[tune] Improve PBT example (#4575)

2019-04-09 20:59:17 -07:00

plasma-object-store.rst

Add note about huge pages using up memory. (#2733)

2018-08-24 17:02:54 -07:00

ppo.png

[rllib] Document "v2" APIs (#2316)

2018-07-01 00:05:08 -07:00

profiling.rst

Update profiling instructions for raylet (#3311)

2018-11-13 17:48:33 -05: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

resources.rst

Document fractional resources. (#3174)

2018-11-01 10:50:56 -07:00

rllib-algorithms.rst

[rllib] TD3/DDPG improvements and MuJoCo benchmarks (#4694)

2019-04-26 17:49:53 -07:00

rllib-api.svg

[rllib] Rename Agent to Trainer (#4556)

2019-04-07 00:36:18 -07:00

rllib-components.svg

[rllib] Update docs with api and components overview figures (#1443)

2018-01-19 10:08:45 -08:00

rllib-concepts.rst

[rllib] Replace ray.get() with ray_get_and_free() to optimize memory usage (#4586)

2019-04-17 20:30:03 -04:00

rllib-config.svg

[rllib] Rename Agent to Trainer (#4556)

2019-04-07 00:36:18 -07:00

rllib-dev.rst

[tune] Contributor Guide and Design Page (#4716)

2019-05-05 00:04:13 -07:00

rllib-env.rst

[rllib] Rename Agent to Trainer (#4556)

2019-04-07 00:36:18 -07: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] Add multi-agent examples for hand-coded policy, centralized VF (#4554)

2019-04-09 00:36:49 -07:00

rllib-models.rst

[rllib] Rename Agent to Trainer (#4556)

2019-04-07 00:36:18 -07:00

rllib-offline.rst

[rllib] Rename Agent to Trainer (#4556)

2019-04-07 00:36:18 -07:00

rllib-package-ref.rst

[rllib] Rename Agent to Trainer (#4556)

2019-04-07 00:36:18 -07: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-training.rst

[rllib] Add multi-agent examples for hand-coded policy, centralized VF (#4554)

2019-04-09 00:36:49 -07:00

rllib.rst

[rllib] Clean up concepts documentation and policy optimizer creation (#4592)

2019-04-12 21:03:26 -07:00

security.rst

Add password authentication to Redis ports (#2952)

2018-10-16 22:48:30 -07:00

serialization.rst

Change Python examples in documentation to use 4 space indentation. (#736)

2017-07-16 22:19:33 -07:00

sgd.png

[sgd] Document and add simple MNIST example (#3236)

2018-11-10 21:52:20 -08:00

signals.rst

[doc] Document experimental signal API. (#4019)

2019-02-28 11:05:28 -08:00

tempfile.rst

API cleanups. Remove worker argument. Remove some deprecated arguments. (#4025)

2019-02-15 10:49:16 -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

Adds a note on how to avoid contention when using PyTorch. (#4692)

2019-04-26 13:22:26 -07:00

tune-contrib.rst

[tune] Contributor Guide and Design Page (#4716)

2019-05-05 00:04:13 -07:00

tune-design.rst

[tune] Contributor Guide and Design Page (#4716)

2019-05-05 00:04:13 -07:00

tune-examples.rst

[tune] Example for Tune blog post (#4673)

2019-05-02 13:16:48 -04:00

tune-package-ref.rst

[Tune] Post-Experiment Tools (#4351)

2019-05-04 02:51:26 -04:00

tune-schedulers.rst

[tune] Improve PBT example (#4575)

2019-04-09 20:59:17 -07:00

tune-searchalg.rst

[tune] Search Alg delay import + CLI timing test (#4230)

2019-04-03 08:52:45 -07:00

tune-usage.rst

[Tune] Post-Experiment Tools (#4351)

2019-05-04 02:51:26 -04:00

tune.rst

[tune] Contributor Guide and Design Page (#4716)

2019-05-05 00:04:13 -07:00

tutorial.rst

Remove local/global_scheduler from code and doc. (#4549)

2019-04-03 17:05:09 -07:00

user-profiling.rst

Update documentation regarding UI and timeline. (#4189)

2019-03-01 19:54:33 -08:00

using-ray-on-a-cluster.rst

Remove local/global_scheduler from code and doc. (#4549)

2019-04-03 17:05:09 -07:00

using-ray-with-gpus.rst

Change Python examples in documentation to use 4 space indentation. (#736)

2017-07-16 22:19:33 -07:00

using-ray-with-tensorflow.rst

Move TensorFlowVariables to ray.experimental.tf_utils. (#4145)

2019-02-24 14:26:46 -08:00