Improve API reference detail and coverage (#252)

yuecideng · web-flow · commit fc545989e7e0 · 2026-05-01T14:24:09.000+08:00
diff --git a/docs/source/api_reference/embodichain/embodichain.agents.rl.algo.rst b/docs/source/api_reference/embodichain/embodichain.agents.rl.algo.rst
@@ -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
+
+.. automodule:: embodichain.agents.rl.algo
+   :members:
+   :undoc-members:
+   :show-inheritance:
    
diff --git a/docs/source/api_reference/embodichain/embodichain.agents.rl.buffer.rst b/docs/source/api_reference/embodichain/embodichain.agents.rl.buffer.rst
@@ -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:
+
    
diff --git a/docs/source/api_reference/embodichain/embodichain.agents.rl.collector.rst b/docs/source/api_reference/embodichain/embodichain.agents.rl.collector.rst
@@ -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:
diff --git a/docs/source/api_reference/embodichain/embodichain.agents.rl.models.rst b/docs/source/api_reference/embodichain/embodichain.agents.rl.models.rst
@@ -3,6 +3,11 @@
 
 .. automodule:: embodichain.agents.rl.models
 
+Overview
+--------
+
+Policy-network registration and model construction APIs for RL agents.
+
    
    .. rubric:: Functions
 
@@ -13,4 +18,9 @@
       get_policy_class
       get_registered_policy_names
       register_policy
+
+.. automodule:: embodichain.agents.rl.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
    
diff --git a/docs/source/api_reference/embodichain/embodichain.agents.rl.rst b/docs/source/api_reference/embodichain/embodichain.agents.rl.rst
@@ -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
@@ -30,6 +37,14 @@ Rollout Buffer
    :undoc-members:
    :show-inheritance:
 
+Collectors
+----------
+
+.. automodule:: embodichain.agents.rl.collector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Policy Models
 -------------
 
diff --git a/docs/source/api_reference/embodichain/embodichain.agents.rl.train.rst b/docs/source/api_reference/embodichain/embodichain.agents.rl.train.rst
@@ -3,6 +3,11 @@
 
 .. automodule:: embodichain.agents.rl.train
 
+Overview
+--------
+
+Training entry points and command-line helpers for launching RL experiments.
+
    
    .. rubric:: Functions
 
@@ -11,4 +16,9 @@
       main
       parse_args
       train_from_config
+
+.. automodule:: embodichain.agents.rl.train
+   :members:
+   :undoc-members:
+   :show-inheritance:
    
diff --git a/docs/source/api_reference/embodichain/embodichain.agents.rl.utils.rst b/docs/source/api_reference/embodichain/embodichain.agents.rl.utils.rst
@@ -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:
+
    
diff --git a/docs/source/api_reference/embodichain/embodichain.agents.rst b/docs/source/api_reference/embodichain/embodichain.agents.rst
@@ -48,6 +48,7 @@ Reinforcement Learning
 
       algo
       buffer
+      collector
       models
       train
       utils
diff --git a/docs/source/api_reference/embodichain/embodichain.data.rst b/docs/source/api_reference/embodichain/embodichain.data.rst
@@ -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:
diff --git a/docs/source/api_reference/embodichain/embodichain.lab.sim.robots.rst b/docs/source/api_reference/embodichain/embodichain.lab.sim.robots.rst
@@ -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
+
    
diff --git a/docs/source/api_reference/embodichain/embodichain.lab.sim.rst b/docs/source/api_reference/embodichain/embodichain.lab.sim.rst
diff --git a/docs/source/api_reference/embodichain/embodichain.lab.sim.types.rst b/docs/source/api_reference/embodichain/embodichain.lab.sim.types.rst
diff --git a/docs/source/api_reference/embodichain/embodichain.lab.sim.utility.rst b/docs/source/api_reference/embodichain/embodichain.lab.sim.utility.rst
diff --git a/docs/source/api_reference/embodichain/embodichain.utils.rst b/docs/source/api_reference/embodichain/embodichain.utils.rst
diff --git a/docs/source/api_reference/index.rst b/docs/source/api_reference/index.rst

-Original file line number
+Diff line change
       algo
       buffer
 +      collector
       models
       train
       utils