style(model-based): fix mypy and polish api docstring (#244)

docs/source/baserlapi/model_based.rst

@@ -0,0 +1,33 @@
+Base Model-based Algorithms
+===========================
+
+.. currentmodule:: omnisafe.algorithms.model_based.base
+
+
+LOOP
+----
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: LOOP
+        :members:
+        :private-members:
+
+PETS
+----
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: PETS
+        :members:
+        :private-members:

docs/source/envs/adapter.rst

@@ -3,6 +3,16 @@ OmniSafe Adapter
 
 .. currentmodule:: omnisafe.adapter
 
+OmniSafe provides a set of adapters to adapt the environment to the framework.
+
+.. autosummary::
+
+    OnlineAdapter
+    OnPolicyAdapter
+    OffPolicyAdapter
+    SauteAdapter
+    SimmerAdapter
+    ModelBasedAdapter
 
 Online Adapter
 --------------
@@ -73,3 +83,17 @@ Simmer Adapter
     .. autoclass:: SimmerAdapter
         :members:
         :private-members:
+
+Model-based Adapter
+-------------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: ModelBasedAdapter
+        :members:
+        :private-members:

docs/source/envs/mujoco_env.rst

@@ -0,0 +1,18 @@
+Mujoco Environment
+==================
+
+.. currentmodule:: omnisafe.envs.mujoco_env
+
+MujocoEnv Interface
+-------------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: MujocoEnv
+        :members:
+        :private-members:

docs/source/envs/safety_gymnasium.rst

@@ -16,3 +16,19 @@ Safety Gymnasium Interface
     .. autoclass:: SafetyGymnasiumEnv
         :members:
         :private-members:
+
+.. currentmodule:: omnisafe.envs.safety_gymnasium_modelbased
+
+Safety Gymnasium World Model
+----------------------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: SafetyGymnasiumModelBased
+        :members:
+        :private-members:

docs/source/envs/wrapper.rst

@@ -98,6 +98,19 @@ Action Scale
         :members:
         :private-members:
 
+Action Repeat
+-------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: ActionRepeat
+        :members:
+        :private-members:
 
 Unsqueeze Wrapper
 -----------------

docs/source/index.rst

@@ -395,6 +395,7 @@ this project, don't hesitate to ask your question on `the GitHub issue page <htt
 
     baserlapi/on_policy
     baserlapi/off_policy
+    baserlapi/model_based
 
 .. toctree::
     :hidden:
@@ -405,6 +406,7 @@ this project, don't hesitate to ask your question on `the GitHub issue page <htt
     saferlapi/second_order
     saferlapi/lagrange
     saferlapi/penalty_function
+    saferlapi/model_based
 
 .. toctree::
     :hidden:
@@ -439,6 +441,8 @@ this project, don't hesitate to ask your question on `the GitHub issue page <htt
     model/actor
     model/critic
     model/actor_critic
+    model/modelbased_model
+    model/modelbased_planner
 
 .. toctree::
     :hidden:
@@ -448,6 +452,7 @@ this project, don't hesitate to ask your question on `the GitHub issue page <htt
     envs/core
     envs/wrapper
     envs/safety_gymnasium
+    envs/mujoco_env
     envs/adapter
 
 

docs/source/model/modelbased_model.rst

@@ -0,0 +1,85 @@
+OmniSafe Model-based Model
+==========================
+
+.. currentmodule:: omnisafe.algorithms.model_based.base.ensemble
+
+Standard Scaler
+---------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: StandardScaler
+        :members:
+        :private-members:
+
+Initialize Weight
+-----------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autofunction:: init_weights
+
+Unbatched Forward
+-----------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autofunction:: unbatched_forward
+
+Ensemble Fully-Connected Layer
+------------------------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: EnsembleFC
+        :members:
+        :private-members:
+
+Ensemble Model
+--------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: EnsembleModel
+        :members:
+        :private-members:
+
+
+Ensemble Dynamics Model
+-----------------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: EnsembleDynamicsModel
+        :members:
+        :private-members:

docs/source/model/modelbased_planner.rst

@@ -0,0 +1,89 @@
+OmniSafe Model-based Planner
+============================
+
+.. currentmodule:: omnisafe.algorithms.model_based.planner
+
+ARC Planner
+-----------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: ARCPlanner
+        :members:
+        :private-members:
+
+CAP Planner
+-----------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: CAPPlanner
+        :members:
+        :private-members:
+
+CCE Planner
+-----------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: CCEPlanner
+        :members:
+        :private-members:
+
+CEM Planner
+-----------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: CEMPlanner
+        :members:
+        :private-members:
+
+RCE Planner
+-----------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: RCEPlanner
+        :members:
+        :private-members:
+
+
+SafeARC Planner
+---------------
+
+.. card::
+    :class-header: sd-bg-success sd-text-white
+    :class-card: sd-outline-success  sd-rounded-1
+
+    Documentation
+    ^^^
+
+    .. autoclass:: SafeARCPlanner
+        :members:
+        :private-members:

docs/source/saferlapi/first_order.rst

@@ -8,10 +8,8 @@ First Order Algorithms
     FOCOPS
     CUP
 
-
 .. _focopsapi:
 
-
 FOCOPS
 ------