[Doc] Use new canonical collector names across docs, tutorials, and SOTA#3665
Merged
Conversation
…OTA implementations Replaces legacy class names (SyncDataCollector, MultiSyncDataCollector, MultiaSyncDataCollector, aSyncDataCollector, _MultiDataCollector, DataCollectorBase, DistributedSyncDataCollector) with the new, shorter canonical names (Collector, MultiSyncCollector, MultiAsyncCollector, AsyncCollector, MultiCollector, BaseCollector, DistributedSyncCollector) in README, docs, tutorials, sota-implementations, examples, benchmarks, tests, and internal docstrings. The legacy class definitions and re-exports in torchrl/collectors/** are preserved for backward compatibility, along with the deprecation tables in docs/source/reference/collectors*.rst. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/rl/3665
Note: Links to docs will display an error until the docs builds have been completed. ❗ 1 Active SEVsThere are 1 currently active SEVs. If your PR is affected, please view them below: ❌ 1 New Failure, 1 Cancelled Job, 2 PendingAs of commit d402cc5 with merge base a8a47a0 ( NEW FAILURE - The following job has failed:
CANCELLED JOB - The following job was cancelled. Please retry:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
meta-cla
Bot
added
the
CLA Signed
github-actions
Bot
added
Documentation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Replaces legacy collector class names with the new, shorter canonical names across user-facing code:
SyncDataCollector→CollectorMultiSyncDataCollector→MultiSyncCollectorMultiaSyncDataCollector→MultiAsyncCollectoraSyncDataCollector→AsyncCollector_MultiDataCollector→MultiCollectorDataCollectorBase→BaseCollectorDistributedSyncDataCollector→DistributedSyncCollectorApplied to README,
docs/,tutorials/,sota-implementations/,examples/,benchmarks/, a couple of test comments, and internal docstrings intorchrl/data/replay_buffers/samplers.py— 50 files total, symmetric 150/150 diff.The legacy class definitions and re-exports in
torchrl/collectors/**are preserved (backward-compatible deprecation shims), and the deprecation tables indocs/source/reference/collectors*.rstare kept intact so users can still see the old→new mapping.Test plan
python -m compileallon changed.pyfiles (all 50 compile locally):class:cross-references since both old and new names are exported fromtorchrl.collectors