docs: update README and add architecture & migration guides - #7
Merged
sbischoff-ai merged 1 commit intoMar 10, 2026
Merged
Conversation
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
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.
Motivation
DQNAgentimports andAdeptlyEngineusage to the new API surface./docsoutput locally.Description
README.mdto reflect current capabilities, roadmap priorities, explicit TensorFlow 1.x migration messaging, and a note explaining how to rebuild generated docs withuv run make docswithout rebuilding/docsin this change.ARCHITECTURE.mdwhich documents agent components, DQN/trainer data flow, the real-time actor/learner split, and the multimodal observation pipeline (schema, normalization, encoders, and fusion).MIGRATION.mdwhich provides before/after code examples and guidance to migrate from legacyadeptly.dqn.DQNAgentandAdeptlyEnginepatterns toadeptly.agents.dqn.DQNAgent,DQNTrainer, andRealTimeInferenceLoop./docsgenerated artifacts; no generated site files were rebuilt or committed as part of this PR.Testing
uv run mypy adeptly testswhich reported no issues.uv run pytest -q, which initially failed during collection due to missing runtime dev dependencies (e.g.numpy,torch).uv sync --frozen --extra devto install required packages and re-ranuv run pytest -q, resulting in all tests passing (15 passed).Codex Task