Skip to content

Improve API reference detail and coverage #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yuecideng merged 1 commit into from
May 1, 2026
Merged

Improve API reference detail and coverage #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/source/api_reference/embodichain/embodichain.agents.rl.algo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,21 @@

.. automodule:: embodichain.agents.rl.algo

Overview
--------

Algorithm registry and algorithm-construction helpers for RL training.


.. rubric:: Functions

.. autosummary::

build_algo
get_registered_algo_names
Comment on lines 11 to 17
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The .. rubric:: Functions / .. autosummary:: block is indented even though it is not inside another directive’s content. In reStructuredText this indentation makes it a block quote, which can lead to odd formatting and/or docutils warnings. Unindent these directives to column 0 (or intentionally nest them under the automodule directive, but then the Overview section would need to be structured accordingly).

Copilot uses AI. Check for mistakes.

.. automodule:: embodichain.agents.rl.algo
:members:
:undoc-members:
Comment on lines 4 to +21
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page declares .. automodule:: embodichain.agents.rl.algo twice (once at the top and again with :members:). This typically duplicates rendered content and can produce Sphinx warnings. Keep only a single automodule directive (and add options to that one if needed).

Copilot uses AI. Check for mistakes.
:show-inheritance:

31 changes: 31 additions & 0 deletions docs/source/api_reference/embodichain/embodichain.agents.rl.buffer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,35 @@

.. automodule:: embodichain.agents.rl.buffer

Overview
--------

The ``buffer`` package provides rollout and replay buffer structures used by
RL algorithms.

.. rubric:: Submodules

.. autosummary::

standard_buffer
utils

.. currentmodule:: embodichain.agents.rl.buffer

Rollout Buffer Classes
----------------------

.. automodule:: embodichain.agents.rl.buffer.standard_buffer
:members:
:undoc-members:
:show-inheritance:

Buffer Utilities
----------------

.. automodule:: embodichain.agents.rl.buffer.utils
:members:
:undoc-members:
:show-inheritance:


33 changes: 33 additions & 0 deletions docs/source/api_reference/embodichain/embodichain.agents.rl.collector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
embodichain.agents.rl.collector
================================

.. automodule:: embodichain.agents.rl.collector

Overview
--------

Collectors are responsible for interacting with vectorized environments and
assembling rollout data into a preallocated ``TensorDict`` layout.

.. rubric:: Classes

.. autosummary::

BaseCollector
SyncCollector

.. currentmodule:: embodichain.agents.rl.collector

BaseCollector
-------------

.. autoclass:: BaseCollector
:members:
:show-inheritance:

SyncCollector
-------------

.. autoclass:: SyncCollector
:members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/source/api_reference/embodichain/embodichain.agents.rl.models.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@

.. automodule:: embodichain.agents.rl.models

Overview
--------

Policy-network registration and model construction APIs for RL agents.


.. rubric:: Functions

Expand All @@ -13,4 +18,9 @@
get_policy_class
get_registered_policy_names
register_policy
Comment on lines 11 to 20
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The .. rubric:: Functions / .. autosummary:: block is indented even though it isn't nested under another directive. This indentation makes it a block quote in RST, which can render strangely and/or cause docutils warnings. Unindent these directives to the left margin (or restructure so they are intentionally within an automodule content block).

Copilot uses AI. Check for mistakes.

.. automodule:: embodichain.agents.rl.models
:members:
:undoc-members:
:show-inheritance:
Comment on lines 4 to +25
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page declares .. automodule:: embodichain.agents.rl.models twice (top and again with :members:). That usually duplicates output and can trigger Sphinx warnings. Prefer a single automodule directive with the desired options.

Copilot uses AI. Check for mistakes.

15 changes: 15 additions & 0 deletions docs/source/api_reference/embodichain/embodichain.agents.rl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@ embodichain.agents.rl

.. automodule:: embodichain.agents.rl

Overview
--------

The ``embodichain.agents.rl`` package contains algorithm registries, rollout
collection logic, policy/model builders, and training entry points.

.. rubric:: Submodules

.. autosummary::
:toctree: .

algo
buffer
collector
models
train
utils
Expand All @@ -30,6 +37,14 @@ Rollout Buffer
:undoc-members:
:show-inheritance:

Collectors
----------

.. automodule:: embodichain.agents.rl.collector
:members:
:undoc-members:
:show-inheritance:

Policy Models
-------------

Expand Down
10 changes: 10 additions & 0 deletions docs/source/api_reference/embodichain/embodichain.agents.rl.train.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@

.. automodule:: embodichain.agents.rl.train

Overview
--------

Training entry points and command-line helpers for launching RL experiments.


.. rubric:: Functions

Expand All @@ -11,4 +16,9 @@
main
parse_args
train_from_config
Comment on lines 11 to 18
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The .. rubric:: Functions / .. autosummary:: block is indented but not actually inside another directive’s content. In RST this becomes a block quote and can lead to incorrect rendering/warnings. Unindent these directives to column 0 (or explicitly nest them under an automodule directive and adjust surrounding structure).

Copilot uses AI. Check for mistakes.

.. automodule:: embodichain.agents.rl.train
:members:
:undoc-members:
:show-inheritance:
Comment on lines 4 to +23
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page declares .. automodule:: embodichain.agents.rl.train twice (once at the top and again with :members:). This can duplicate rendered content and may raise Sphinx warnings. Keep a single automodule directive and attach the desired options to it.

Copilot uses AI. Check for mistakes.

38 changes: 38 additions & 0 deletions docs/source/api_reference/embodichain/embodichain.agents.rl.utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,42 @@

.. automodule:: embodichain.agents.rl.utils

Overview
--------

The ``utils`` package contains helper utilities for RL configuration,
data conversion, and training orchestration.

.. rubric:: Submodules

.. autosummary::

config
helper
trainer

Configuration Helpers
---------------------

.. automodule:: embodichain.agents.rl.utils.config
:members:
:undoc-members:
:show-inheritance:

General Helpers
---------------

.. automodule:: embodichain.agents.rl.utils.helper
:members:
:undoc-members:
:show-inheritance:

Trainer Utilities
-----------------

.. automodule:: embodichain.agents.rl.utils.trainer
:members:
:undoc-members:
:show-inheritance:


1 change: 1 addition & 0 deletions docs/source/api_reference/embodichain/embodichain.agents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Reinforcement Learning

algo
buffer
collector
models
train
utils
51 changes: 51 additions & 0 deletions docs/source/api_reference/embodichain/embodichain.data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
embodichain.data
================

.. automodule:: embodichain.data

Data Package Overview
---------------------

The ``embodichain.data`` package centralizes dataset resolution and asset download
helpers used by simulation tasks and training pipelines.

.. rubric:: Submodules

.. autosummary::

constants
dataset
download
enum

Constants
---------

.. automodule:: embodichain.data.constants
:members:
:undoc-members:
:show-inheritance:

Dataset Resolution
------------------

.. automodule:: embodichain.data.dataset
:members:
:undoc-members:
:show-inheritance:

Asset Download CLI
------------------

.. automodule:: embodichain.data.download
:members:
:undoc-members:
:show-inheritance:

Enums
-----

.. automodule:: embodichain.data.enum
:members:
:undoc-members:
:show-inheritance:
19 changes: 19 additions & 0 deletions docs/source/api_reference/embodichain/embodichain.lab.sim.robots.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,23 @@

.. automodule:: embodichain.lab.sim.robots

Overview
--------

This module exposes robot-specific configuration presets for simulation scenes.

.. rubric:: Classes

.. autosummary::

CobotMagicCfg

.. currentmodule:: embodichain.lab.sim.robots

.. autoclass:: CobotMagicCfg
:members:
:inherited-members:
:show-inheritance:
:exclude-members: __init__, copy, replace, to_dict, validate


Loading
Loading