Skip to content

[Doc] Explain DreamerV3 architecture and nomenclature - #4095

Merged
vmoens merged 2 commits into
gh/vmoens/293/basefrom
gh/vmoens/293/head
Aug 12, 2026
Merged

[Doc] Explain DreamerV3 architecture and nomenclature#4095
vmoens merged 2 commits into
gh/vmoens/293/basefrom
gh/vmoens/293/head

Conversation

…data flow, objectives, optimizer ownership, and slow-critic soft updates.

[ghstack-poisoned]
@pytorch-bot

pytorch-bot Bot commented Aug 12, 2026

Copy link
Copy Markdown

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/rl/4095

Note: Links to docs will display an error until the docs builds have been completed.

✅ You can merge normally! (2 Unrelated Failures)

As of commit 83c8169 with merge base d5a62cb (image):

BROKEN TRUNK - The following jobs failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@vmoens

vmoens commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator Author

Added a dedicated “DreamerV3 in a nutshell” API-reference page.

It now:

  • defines the world model, belief/deterministic state, stochastic state, prior, posterior, imagination, critic, slow critic, and continuation terminology;
  • explains the real-data RSSM filtering path and the prior-only imagination path;
  • summarizes the world-model, actor, and critic objectives and their supported variants;
  • clarifies that the slow critic is a Polyak/soft-updated target used for critic regularization, while the online critic remains the imagined lambda-return bootstrap;
  • documents the external SoftUpdate call and exact update equation;
  • separates the optimizer-agnostic loss API from the runnable example’s three Adam optimizers, warmup, and adaptive gradient clipping; and
  • provides an API map linking the DreamerV3 modules, objectives, and scalar-transform helpers.

Validation: documentation-relevant pre-commit hooks pass, the new page passes a warnings-as-errors Sphinx parse, and all referenced TorchRL API targets resolve.

…vigation and added contextual links from the DreamerV3 loss, RSSM, and world-model API documentation.

[ghstack-poisoned]
@vmoens

vmoens commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator Author

Addressed the discoverability/placement feedback:

  • moved the DreamerV3 overview from the first position to the final position in the objectives navigation;
  • linked it contextually from the DreamerV3ModelLoss, DreamerV3ActorLoss, and DreamerV3ValueLoss docstrings;
  • added contextual links from the three DreamerV3 RSSM class docstrings; and
  • linked it from the world-model API section.

This keeps the page discoverable when readers encounter the relevant API without presenting it as the primary objectives entry.

Validation: documentation-relevant pre-commit hooks pass, an isolated Sphinx warnings-as-errors build resolves all new links, and the two DreamerV3 module doctest suites pass (15 tests).

vmoens added a commit that referenced this pull request Aug 12, 2026
@vmoens
vmoens merged commit 83c8169 into gh/vmoens/293/base Aug 12, 2026
118 of 120 checks passed
@vmoens
vmoens deleted the gh/vmoens/293/head branch August 12, 2026 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. Documentation Improvements or additions to documentation Integrations/torch_geometric Integrations Modules Objectives

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant