Skip to content

Commit

Permalink
[RLlib; docs] RLlib documentation do-over (new API stack): Main index…
Browse files Browse the repository at this point in the history
… page. (ray-project#48285)
  • Loading branch information
sven1977 authored and Jay-ju committed Nov 5, 2024
1 parent ff55430 commit 9850944
Show file tree
Hide file tree
Showing 13 changed files with 342 additions and 391 deletions.
6 changes: 3 additions & 3 deletions doc/source/_includes/rllib/new_api_stack.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. note::

Ray 2.10.0 introduces the alpha stage of RLlib's "new API stack".
The Ray Team plans to transition algorithms, example scripts, and documentation to the new code base
thereby incrementally replacing the "old API stack" (e.g., ModelV2, Policy, RolloutWorker) throughout the subsequent minor releases leading up to Ray 3.0.
The team is currently transitioning algorithms, example scripts, and
documentation to the new code base throughout the subsequent minor releases leading up to Ray 3.0.

:doc:`See here </rllib/rllib-new-api-stack>` for more details on how to use the new API stack.
:doc:`See here </rllib/rllib-new-api-stack>` for more details on how to activate and use the new API stack.
6 changes: 3 additions & 3 deletions doc/source/rllib/doc_code/rllib_in_60s.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

# __rllib-in-60s-begin__
from ray.rllib.algorithms.ppo import PPOConfig
from ray.rllib.core.rl_module.default_model_config import DefaultModelConfig

config = ( # 1. Configure the algorithm,
PPOConfig()
.environment("Taxi-v3")
.environment(env="Taxi-v3")
.env_runners(num_env_runners=2)
.framework("torch")
.training(model={"fcnet_hiddens": [64, 64]})
.rl_module(model_config=DefaultModelConfig(fcnet_hiddens=[64, 64]))
.evaluation(evaluation_num_env_runners=1)
)

Expand Down
85 changes: 0 additions & 85 deletions doc/source/rllib/feature_overview.rst

This file was deleted.

1 change: 1 addition & 0 deletions doc/source/rllib/images/algos/cql-architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/source/rllib/images/rllib-new-api-stack-simple.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file removed doc/source/rllib/images/rllib-stack.png
Binary file not shown.
1 change: 0 additions & 1 deletion doc/source/rllib/images/sigils/new-api-stack.svg

This file was deleted.

1 change: 0 additions & 1 deletion doc/source/rllib/images/sigils/old-api-stack.svg

This file was deleted.

Loading

0 comments on commit 9850944

Please sign in to comment.