Merge pull request #742 from fhswf/rtd/automodule

RTD: Refactoring API References
fhswf · Apr 24, 2023 · a9ae78a · a9ae78a
2 parents 4763055 + dc257ae
commit a9ae78a
Show file tree

Hide file tree

Showing 46 changed files with 45 additions and 1 deletion.
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_gt/01_basics.rst b/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_gt/01_basics.rst
@@ -8,4 +8,5 @@ GT - Basics
 .. automodule:: mlpro.gt.models
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_oa/01_streams.rst b/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_oa/01_streams.rst
@@ -8,4 +8,5 @@ OA-STREAMS - Online-adaptive Stream Processing
 .. automodule:: mlpro.oa.streams.basics
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...04_appendices/appendix2/sub/core/mlpro_oa/images/.$MLPro-OA-Proc_class_diagram.drawio.bkp b/...04_appendices/appendix2/sub/core/mlpro_oa/images/.$MLPro-OA-Proc_class_diagram.drawio.bkp
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_rl/01_environments.rst b/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_rl/01_environments.rst
@@ -8,4 +8,5 @@ RL-ENV - Environments
 .. automodule:: mlpro.rl.models_env
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_rl/02_env_models.rst b/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_rl/02_env_models.rst
@@ -8,4 +8,5 @@ RL-ENV-ADA - Environment Models
 .. automodule:: mlpro.rl.models_env_ada
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_rl/11_agents.rst b/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_rl/11_agents.rst
@@ -8,4 +8,5 @@ RL-AGENTS - Agents
 .. automodule:: mlpro.rl.models_agents
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...rtd/content/04_appendices/appendix2/sub/core/mlpro_rl/21_scenarios_training.rst b/...rtd/content/04_appendices/appendix2/sub/core/mlpro_rl/21_scenarios_training.rst
@@ -8,4 +8,5 @@ RL-TRAIN - Scenarios, Training and Tuning
 .. automodule:: mlpro.rl.models_train
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_sl/01_basics.rst b/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_sl/01_basics.rst
@@ -8,4 +8,5 @@ SL - Basics
 .. automodule:: mlpro.sl.basics
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_sl/02_fnn.rst b/doc/rtd/content/04_appendices/appendix2/sub/core/mlpro_sl/02_fnn.rst
@@ -8,4 +8,5 @@ SL - Feedforward Neural Network
 .. automodule:: mlpro.sl.fnn
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...tent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/samplers/min_wise.rst b/...tent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/samplers/min_wise.rst
@@ -4,4 +4,5 @@ Min-Wise Samplers
 .. automodule:: mlpro.bf.streams.samplers.min_wise
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...ontent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/samplers/random.rst b/...ontent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/samplers/random.rst
@@ -4,4 +4,5 @@ Random Samplers
 .. automodule:: mlpro.bf.streams.samplers.random
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...ent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/samplers/reservoir.rst b/...ent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/samplers/reservoir.rst
@@ -4,4 +4,5 @@ Reservoir Samplers with Algorithm R
 .. automodule:: mlpro.bf.streams.samplers.reservoir_sampling
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/..._appendices/appendix2/sub/pool/mlpro_bf/bf_streams/samplers/weighted_random.rst b/..._appendices/appendix2/sub/pool/mlpro_bf/bf_streams/samplers/weighted_random.rst
@@ -4,4 +4,5 @@ Weighted Random Samplers
 .. automodule:: mlpro.bf.streams.samplers.weighted_random
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...4_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/clouds2d_static.rst b/...4_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/clouds2d_static.rst
@@ -4,4 +4,5 @@
 .. automodule:: mlpro.bf.streams.streams.clouds2d_static
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...4_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/clouds3d_static.rst b/...4_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/clouds3d_static.rst
@@ -4,4 +4,5 @@
 .. automodule:: mlpro.bf.streams.streams.clouds3d_static
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...ntent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/csv_file.rst b/...ntent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/csv_file.rst
@@ -5,4 +5,5 @@ Data from CSV files
 .. automodule:: mlpro.bf.streams.streams.csv_file
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/doublespiral2d.rst b/...04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/doublespiral2d.rst
@@ -4,4 +4,5 @@
 .. automodule:: mlpro.bf.streams.streams.doublespiral2d
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...content/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/rnd10d.rst b/...content/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/streams/rnd10d.rst
@@ -4,4 +4,5 @@
 .. automodule:: mlpro.bf.streams.streams.rnd10d
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/.../content/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/tasks/deriver.rst b/.../content/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/tasks/deriver.rst
@@ -4,4 +4,5 @@ Deriver
 .. automodule:: mlpro.bf.streams.tasks.deriver
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...ntent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/tasks/rearranger.rst b/...ntent/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/tasks/rearranger.rst
@@ -4,4 +4,5 @@ Rearranger
 .. automodule:: mlpro.bf.streams.tasks.rearranger
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/.../content/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/tasks/windows.rst b/.../content/04_appendices/appendix2/sub/pool/mlpro_bf/bf_streams/tasks/windows.rst
@@ -4,4 +4,5 @@ Windows
 .. automodule:: mlpro.bf.streams.tasks.windows
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...ces/appendix2/sub/pool/mlpro_bf/bf_systems/01_double_pendulum_native_system.rst b/...ces/appendix2/sub/pool/mlpro_bf/bf_systems/01_double_pendulum_native_system.rst
@@ -8,4 +8,5 @@ Double Pendulum System
 .. automodule:: mlpro.bf.systems.pool.doublependulum
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_gt/game_boards/bglp.rst b/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_gt/game_boards/bglp.rst
@@ -4,5 +4,6 @@ Bulk Goods Plant
 .. automodule:: mlpro.gt.pool.boards.bglp
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
 
diff --git a/...ontent/04_appendices/appendix2/sub/pool/mlpro_gt/game_boards/multi_cartpole.rst b/...ontent/04_appendices/appendix2/sub/pool/mlpro_gt/game_boards/multi_cartpole.rst
@@ -4,4 +4,5 @@ Multi-Cartpole
 .. automodule:: mlpro.gt.pool.boards.multicartpole
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_rl/action_planners/mpc.rst b/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_rl/action_planners/mpc.rst
@@ -5,4 +5,5 @@ MPC - Model Predictive Control
 .. automodule:: mlpro.rl.pool.actionplanner.mpc
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_rl/environments/bglp.rst b/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_rl/environments/bglp.rst
@@ -5,4 +5,5 @@ Bulk Goods Plant
 .. automodule:: mlpro.rl.pool.envs.bglp
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...tent/04_appendices/appendix2/sub/pool/mlpro_rl/environments/double_pendulum.rst b/...tent/04_appendices/appendix2/sub/pool/mlpro_rl/environments/double_pendulum.rst
@@ -8,4 +8,5 @@ Double Pendulum
 .. automodule:: mlpro.rl.pool.envs.doublependulum
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...d/content/04_appendices/appendix2/sub/pool/mlpro_rl/environments/grid_world.rst b/...d/content/04_appendices/appendix2/sub/pool/mlpro_rl/environments/grid_world.rst
@@ -5,4 +5,5 @@ Grid World
 .. automodule:: mlpro.rl.pool.envs.gridworld
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...ntent/04_appendices/appendix2/sub/pool/mlpro_rl/environments/multi_cartpole.rst b/...ntent/04_appendices/appendix2/sub/pool/mlpro_rl/environments/multi_cartpole.rst
@@ -5,4 +5,5 @@ Multi-Cartpole
 .. automodule:: mlpro.rl.pool.envs.multicartpole
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...nt/04_appendices/appendix2/sub/pool/mlpro_rl/environments/robot_manipulator.rst b/...nt/04_appendices/appendix2/sub/pool/mlpro_rl/environments/robot_manipulator.rst
@@ -5,4 +5,5 @@ Robot Manipulator
 .. automodule:: mlpro.rl.pool.envs.robotinhtm
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_rl/policies/dummy.rst b/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_rl/policies/dummy.rst
@@ -4,4 +4,5 @@ Dummy
 .. automodule:: mlpro.rl.pool.policies.dummy
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_rl/policies/random.rst b/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_rl/policies/random.rst
@@ -5,4 +5,5 @@ Random Actions
 .. automodule:: mlpro.rl.pool.policies.randomgenerator
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...nt/04_appendices/appendix2/sub/pool/mlpro_rl/sars_buffers/prioritizedbuffer.rst b/...nt/04_appendices/appendix2/sub/pool/mlpro_rl/sars_buffers/prioritizedbuffer.rst
@@ -4,4 +4,5 @@ Prioritized Buffer
 .. automodule:: mlpro.rl.pool.sarsbuffer.PrioritizedBuffer
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...ent/04_appendices/appendix2/sub/pool/mlpro_rl/sars_buffers/randomsarsbuffer.rst b/...ent/04_appendices/appendix2/sub/pool/mlpro_rl/sars_buffers/randomsarsbuffer.rst
@@ -4,4 +4,5 @@ Random SARS Buffer
 .. automodule:: mlpro.rl.pool.sarsbuffer.RandomSARSBuffer
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/...content/04_appendices/appendix2/sub/pool/mlpro_sl/afct/afct_fnn_pytorch_mlp.rst b/...content/04_appendices/appendix2/sub/pool/mlpro_sl/afct/afct_fnn_pytorch_mlp.rst
@@ -7,4 +7,5 @@ PyTorch-based MLP
 .. automodule:: mlpro.sl.pool.afct.fnn.pytorch.mlp
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_sl/afct/afct_pytorch.rst b/doc/rtd/content/04_appendices/appendix2/sub/pool/mlpro_sl/afct/afct_pytorch.rst
@@ -7,4 +7,5 @@ PyTorch Helper Functions
 .. automodule:: mlpro.sl.pool.afct.pytorch
    :members:
    :undoc-members:
+   :private-members:
    :show-inheritance:
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/gymnasium.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/gymnasium.rst
@@ -5,6 +5,7 @@ Gymnasium
 .. automodule:: mlpro.wrappers.gymnasium
     :members:
     :undoc-members:
+    :private-members:
     :show-inheritance:
 
 

diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/hyperopt.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/hyperopt.rst
@@ -5,6 +5,7 @@ Hyperopt
 .. automodule:: mlpro.wrappers.hyperopt
     :members:
     :undoc-members:
+    :private-members:
     :show-inheritance:
 
 

diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/mujoco.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/mujoco.rst
@@ -8,6 +8,7 @@ MuJoCo
 .. automodule:: mlpro.wrappers.mujoco
     :members:
     :undoc-members:
+    :private-members:
     :show-inheritance:
 
 

diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/openai_gym.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/openai_gym.rst
@@ -5,6 +5,7 @@ OpenAI Gym
 .. automodule:: mlpro.wrappers.openai_gym
     :members:
     :undoc-members:
+    :private-members:
     :show-inheritance:
 
 

diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/openml.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/openml.rst
@@ -6,6 +6,7 @@ OpenML
     .. automodule:: mlpro.wrappers.openml
         :members:
         :undoc-members:
+        :private-members:
         :show-inheritance:
    
 

diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/optuna.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/optuna.rst
@@ -5,6 +5,7 @@ Optuna
 .. automodule:: mlpro.wrappers.optuna
     :members:
     :undoc-members:
+    :private-members:
     :show-inheritance:
 
 

diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/pettingzoo.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/pettingzoo.rst
@@ -5,6 +5,7 @@ PettingZoo
 .. automodule:: mlpro.wrappers.pettingzoo
     :members:
     :undoc-members:
+    :private-members:
     :show-inheritance:
 
 

diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/river.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/river.rst
@@ -5,6 +5,7 @@ River
 .. automodule:: mlpro.wrappers.river
     :members:
     :undoc-members:
+    :private-members:
     :show-inheritance:
 
 

diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/sb3.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/sb3.rst
@@ -5,6 +5,7 @@ Stable Baslines3
 .. automodule:: mlpro.wrappers.sb3
     :members:
     :undoc-members:
+    :private-members:
     :show-inheritance:
 
 

diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/sklearn.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/sklearn.rst
@@ -5,6 +5,7 @@ Scikit-learn
 .. automodule:: mlpro.wrappers.sklearn
     :members:
     :undoc-members:
+    :private-members:
     :show-inheritance: