[RLlib] Docs do-over (new API stack): Remove all old API stack package_ref docs.
#49518
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…_redo_algorithm_configurations
…_redo_key_concepts # Conflicts: # doc/source/rllib/rllib-rlmodule.rst
…_redo_algorithm_configurations
sven1977
requested review from
maxpumperla,
simonsays1980 and
a team
as code owners
sven1977
added
rllib
…_redo_cleanup_all_old_api_stack_package_ref Signed-off-by: sven1977 <svenmika1977@gmail.com> # Conflicts: # doc/source/rllib/key-concepts.rst # doc/source/rllib/package_ref/env.rst
simonsays1980
approved these changes
Jan 3, 2025
| * :py:class:`~ray.rllib.connector.connector_v2.ConnectorV2` (replaces :py:class:`~ray.rllib.connector.connector.Connector` and some of :py:class:`~ray.rllib.evaluation.rollout_worker.RolloutWorker` and :py:class:`~ray.rllib.policy.policy.Policy`) | ||
| * :py:class:`~ray.rllib.core.rl_module.rl_module.RLModule` (replaces ``ModelV2`` and ``PolicyMap`` APIs) | ||
| * :py:class:`~ray.rllib.core.learner.learner.Learner` (replaces ``RolloutWorker`` and some of ``Policy``) | ||
| * :py:class:`~ray.rllib.env.single_agent_episode.SingleAgentEpisode` and :py:class:`~ray.rllib.env.multi_agent_episode.MultiAgentEpisode` (replaces ``ViewRequirement``, ``SampleCollector``, ``Episode``, and ``EpisodeV2``) |
There was a problem hiding this comment.
When do we use double quotes and when single quotes for code?
There was a problem hiding this comment.
Good question! :)
I think we should always use double quotes, in the docs ... 🤔
There was a problem hiding this comment.
Yup, double quotes for code and variables, single quotes only for references, such as:
:py:class:`...`
:ref:`... <>`
`.. <link>`__
:py:meth:`...`
:py:attr:`...`
roshankathawate
pushed a commit
to roshankathawate/ray
that referenced
this pull request
Jan 7, 2025
roshankathawate
pushed a commit
to roshankathawate/ray
that referenced
this pull request
Jan 9, 2025
…ge_ref` docs. (ray-project#49518) Signed-off-by: Roshan Kathawate <roshankathawate@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs do-over (new API stack): Remove all old API stack
package_refdocs.package_refwhere missing.package_refchanges) not merged yet ...Why are these changes needed?
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.