Added Private members to documentation pages.

bozo-bud · bozo-bud · commit d2afff219e0a · 2025-07-08T16:30:06.000-04:00
diff --git a/docs/reinforcement_learning/algorithms/a2c.rst b/docs/reinforcement_learning/algorithms/a2c.rst
@@ -7,3 +7,4 @@ It defines the observation and action spaces used during simulation.
 .. automodule:: reinforcement_learning.algorithms.a2c
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/algorithms/algorithm_props.rst b/docs/reinforcement_learning/algorithms/algorithm_props.rst
@@ -7,3 +7,4 @@ The ``algorithm_props.py`` module defines core property containers for Q-learnin
 .. automodule:: reinforcement_learning.algorithms.algorithm_props
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/algorithms/bandits.rst b/docs/reinforcement_learning/algorithms/bandits.rst
@@ -7,3 +7,4 @@ It includes helper functions for model saving, value updates, and Q-table constr
 .. automodule:: reinforcement_learning.algorithms.bandits
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/algorithms/dqn.rst b/docs/reinforcement_learning/algorithms/dqn.rst
@@ -7,3 +7,4 @@ Deep Q-Network (DQN) reinforcement learning.
 .. automodule:: reinforcement_learning.algorithms.dqn
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/algorithms/ppo.rst b/docs/reinforcement_learning/algorithms/ppo.rst
@@ -7,3 +7,4 @@ Proximal Policy Optimization (PPO) reinforcement learning.
 .. automodule:: reinforcement_learning.algorithms.ppo
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/algorithms/q_learning.rst b/docs/reinforcement_learning/algorithms/q_learning.rst
@@ -7,3 +7,4 @@ It handles matrix initialization, reward updates, temporal difference error trac
 .. automodule:: reinforcement_learning.algorithms.q_learning
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/algorithms/qr_dqn.rst b/docs/reinforcement_learning/algorithms/qr_dqn.rst
@@ -7,3 +7,4 @@ The ``qr_dqn.py`` module defines the observation and action space configuration
 .. automodule:: reinforcement_learning.algorithms.qr_dqn
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/feat_extrs/graphormer.rst b/docs/reinforcement_learning/feat_extrs/graphormer.rst
@@ -8,3 +8,4 @@ multi-head attention over topology-aware input features.
 .. automodule:: reinforcement_learning.feat_extrs.graphormer
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/feat_extrs/path_gnn.rst b/docs/reinforcement_learning/feat_extrs/path_gnn.rst
@@ -7,3 +7,4 @@ for use in reinforcement learning environments that involve path selection.
 .. automodule:: reinforcement_learning.feat_extrs.path_gnn
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/feat_extrs/path_gnn_cached.rst b/docs/reinforcement_learning/feat_extrs/path_gnn_cached.rst
@@ -8,3 +8,4 @@ This is especially useful for fixed network topologies where recomputing embeddi
 .. automodule:: reinforcement_learning.feat_extrs.path_gnn_cached
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/gymnasium_envs/general_sim_env.rst b/docs/reinforcement_learning/gymnasium_envs/general_sim_env.rst
@@ -10,4 +10,5 @@ spectrum assignment and topology-aware step logic.
 .. automodule:: reinforcement_learning.gymnasium_envs.general_sim_env
     :members:
     :undoc-members:
+    :private-members:
 
diff --git a/docs/reinforcement_learning/model_manager.rst b/docs/reinforcement_learning/model_manager.rst
@@ -8,4 +8,4 @@ hyperparameter configurations.
 .. automodule:: reinforcement_learning.model_manager
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/blocking.rst b/docs/reinforcement_learning/plotting/blocking.rst
@@ -8,4 +8,5 @@ and statistical heatmaps of routing algorith
 .. automodule:: reinforcement_learning.plotting.blocking
     :members:
     :undoc-members:
+    :private-members:
 
diff --git a/docs/reinforcement_learning/plotting/bw_block.rst b/docs/reinforcement_learning/plotting/bw_block.rst
@@ -7,4 +7,4 @@ This module plots normalized blocked bandwidth based on request distribution and
 .. automodule:: reinforcement_learning.plotting.bw_block
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/link_data.rst b/docs/reinforcement_learning/plotting/link_data.rst
@@ -6,4 +6,4 @@ This module provides visualizations of link usage and throughput in optical netw
 .. automodule:: reinforcement_learning.plotting.link_data
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/loaders.rst b/docs/reinforcement_learning/plotting/loaders.rst
@@ -6,3 +6,4 @@ This module loads simulation output, metadata, and metrics for DRL and heuristic
 .. automodule:: reinforcement_learning.plotting.loaders
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/memory_usage.rst b/docs/reinforcement_learning/plotting/memory_usage.rst
@@ -6,4 +6,4 @@ This module visualizes peak memory usage across traffic volumes and algorithms u
 .. automodule:: reinforcement_learning.plotting.memory_usage
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/mod_usage.rst b/docs/reinforcement_learning/plotting/mod_usage.rst
@@ -6,4 +6,4 @@ This module contains logic for rendering modulation usage breakdowns per bandwid
 .. automodule:: reinforcement_learning.plotting.mod_usage
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/path_index.rst b/docs/reinforcement_learning/plotting/path_index.rst
@@ -6,4 +6,4 @@ This module visualizes how often each path index was selected by different algor
 .. automodule:: reinforcement_learning.plotting.path_index
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/plot_runner.rst b/docs/reinforcement_learning/plotting/plot_runner.rst
@@ -7,4 +7,4 @@ data merging, algorithm detection, and conditional logic for DRL/non-DRL output.
 .. automodule:: reinforcement_learning.plotting.plot_runner
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/processors.rst b/docs/reinforcement_learning/plotting/processors.rst
@@ -7,4 +7,4 @@ aggregating blocking probability, memory usage, simulation time, and statistical
 .. automodule:: reinforcement_learning.plotting.processors
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/resource_stats.rst b/docs/reinforcement_learning/plotting/resource_stats.rst
@@ -7,4 +7,4 @@ relative to baseline algorithms.
 .. automodule:: reinforcement_learning.plotting.resource_stats
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/rewards.rst b/docs/reinforcement_learning/plotting/rewards.rst
@@ -6,4 +6,4 @@ This module plots per-episode mean reward and standard deviation with CI shading
 .. automodule:: reinforcement_learning.plotting.rewards
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/sim_times.rst b/docs/reinforcement_learning/plotting/sim_times.rst
@@ -7,3 +7,4 @@ per traffic volume and algorithm. Output can be saved or displayed inline.
 .. automodule:: reinforcement_learning.plotting.sim_times
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/plotting/state_values.rst b/docs/reinforcement_learning/plotting/state_values.rst
@@ -7,3 +7,4 @@ based on averaged Q-values or learned scores. Output can be shown or saved.
 .. automodule:: reinforcement_learning.plotting.state_values
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/policies/pointer_policy.rst b/docs/reinforcement_learning/policies/pointer_policy.rst
@@ -8,3 +8,4 @@ that integrates with Stable Baselines3.
 .. automodule:: reinforcement_learning.policies.pointer_policy
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/cache_gnn_once.rst b/docs/reinforcement_learning/utils/cache_gnn_once.rst
@@ -4,3 +4,4 @@ Single GNN Cache
 .. automodule:: reinforcement_learning.utils.cache_gnn_once
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/callbacks.rst b/docs/reinforcement_learning/utils/callbacks.rst
@@ -4,3 +4,4 @@ Callbacks
 .. automodule:: reinforcement_learning.utils.callbacks
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/deep_rl.rst b/docs/reinforcement_learning/utils/deep_rl.rst
@@ -4,4 +4,4 @@ Deep Reinforcement Learning
 .. automodule:: reinforcement_learning.utils.deep_rl
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/general_utils.rst b/docs/reinforcement_learning/utils/general_utils.rst
@@ -4,4 +4,4 @@ General Utilities
 .. automodule:: reinforcement_learning.utils.general_utils
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/gym_envs.rst b/docs/reinforcement_learning/utils/gym_envs.rst
@@ -4,3 +4,4 @@ Gymnasium Environments
 .. automodule:: reinforcement_learning.utils.gym_envs
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/hyperparams.rst b/docs/reinforcement_learning/utils/hyperparams.rst
@@ -4,4 +4,4 @@ Hyperparameters
 .. automodule:: reinforcement_learning.utils.hyperparams
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/observation_space.rst b/docs/reinforcement_learning/utils/observation_space.rst
@@ -4,4 +4,4 @@ Observation Spaces
 .. automodule:: reinforcement_learning.utils.observation_space
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/rl_zoo.rst b/docs/reinforcement_learning/utils/rl_zoo.rst
@@ -4,4 +4,4 @@ RL Zoo
 .. automodule:: reinforcement_learning.utils.rl_zoo
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/setup.rst b/docs/reinforcement_learning/utils/setup.rst
@@ -4,4 +4,4 @@ Setup Utilities
 .. automodule:: reinforcement_learning.utils.setup
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/sim_data.rst b/docs/reinforcement_learning/utils/sim_data.rst
@@ -4,4 +4,4 @@ Simulation Data Utilities
 .. automodule:: reinforcement_learning.utils.sim_data
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/sim_env.rst b/docs/reinforcement_learning/utils/sim_env.rst
@@ -4,4 +4,4 @@ Simulation Environment Utilities
 .. automodule:: reinforcement_learning.utils.sim_env
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/sim_filters.rst b/docs/reinforcement_learning/utils/sim_filters.rst
@@ -4,3 +4,4 @@ Simulation Filters
 .. automodule:: reinforcement_learning.utils.sim_filters
     :members:
     :undoc-members:
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/topology.rst b/docs/reinforcement_learning/utils/topology.rst
@@ -4,4 +4,4 @@ Topology
 .. automodule:: reinforcement_learning.utils.topology
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/utils/unity_hyperparams.rst b/docs/reinforcement_learning/utils/unity_hyperparams.rst
@@ -4,4 +4,4 @@ Unity Hyperparameters
 .. automodule:: reinforcement_learning.utils.unity_hyperparams
     :members:
     :undoc-members:
-
+    :private-members:
diff --git a/docs/reinforcement_learning/workflow_runner.rst b/docs/reinforcement_learning/workflow_runner.rst
@@ -10,3 +10,4 @@ and reward logging.
 .. automodule:: reinforcement_learning.workflow_runner
     :members:
     :undoc-members:
+    :private-members:
diff --git a/ini/example_ini/example_config.ini b/ini/example_ini/example_config.ini
