File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -57,7 +57,7 @@ Optimizers
5757----------
5858
5959SciPy Optimizer
60- ~~~~~~~~~~~~~~
60+ ~~~~~~~~~~~~~~~
6161
6262.. autoclass :: pyppur.optimizers.ScipyOptimizer
6363 :members:
@@ -66,7 +66,7 @@ SciPy Optimizer
6666 :show-inheritance:
6767
6868Grid Optimizer
69- ~~~~~~~~~~~~~
69+ ~~~~~~~~~~~~~~
7070
7171.. autoclass :: pyppur.optimizers.GridOptimizer
7272 :members:
@@ -75,7 +75,7 @@ Grid Optimizer
7575 :show-inheritance:
7676
7777Utility Functions
78- ----------------
78+ -----------------
7979
8080Metrics
8181~~~~~~~
@@ -86,25 +86,25 @@ Metrics
8686 :show-inheritance:
8787
8888Preprocessing
89- ~~~~~~~~~~~~
89+ ~~~~~~~~~~~~~
9090
9191.. automodule :: pyppur.utils.preprocessing
9292 :members:
9393 :undoc-members:
9494 :show-inheritance:
9595
9696Visualization
97- ~~~~~~~~~~~~
97+ ~~~~~~~~~~~~~
9898
9999.. automodule :: pyppur.utils.visualization
100100 :members:
101101 :undoc-members:
102102 :show-inheritance:
103103
104104Helper Functions
105- ---------------
105+ ----------------
106106
107107Normalization
108- ~~~~~~~~~~~~
108+ ~~~~~~~~~~~~~
109109
110110.. autofunction :: pyppur.optimizers.scipy_optimizer.normalize_projection_directions
Original file line number Diff line number Diff line change 44This section provides comprehensive examples of using pyppur for different scenarios.
55
66Basic Usage Examples
7- -------------------
7+ --------------------
88
99Distance Distortion Example
1010~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -68,7 +68,7 @@ Distance Distortion Example
6868 plt.show()
6969
7070 Reconstruction Examples
71- ~~~~~~~~~~~~~~~~~~~~~~
71+ ~~~~~~~~~~~~~~~~~~~~~~~
7272
7373.. code-block :: python
7474
@@ -108,10 +108,10 @@ Reconstruction Examples
108108 print (" Untied decoder shape:" , pp_untied.decoder_weights_.shape)
109109
110110 Advanced Examples
111- ----------------
111+ -----------------
112112
113113Parameter Sensitivity Analysis
114- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115115
116116.. code-block :: python
117117
@@ -161,7 +161,7 @@ Parameter Sensitivity Analysis
161161 plt.show()
162162
163163 Comparison with Other Methods
164- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
165165
166166.. code-block :: python
167167
@@ -237,7 +237,7 @@ Comparison with Other Methods
237237 print (f " { method} : { time_taken:.3f } seconds " )
238238
239239 Evaluation and Metrics
240- ~~~~~~~~~~~~~~~~~~~~~
240+ ~~~~~~~~~~~~~~~~~~~~~~
241241
242242.. code-block :: python
243243
@@ -316,7 +316,7 @@ Working with Large Datasets
316316 print (f " Processed { X_scaled.shape[0 ]} samples in { pp_large.fit_time_:.2f } seconds " )
317317
318318 Custom Workflows
319- ~~~~~~~~~~~~~~~
319+ ~~~~~~~~~~~~~~~~
320320
321321.. code-block :: python
322322
Original file line number Diff line number Diff line change @@ -5,6 +5,7 @@ pyppur.objectives package
55 :members:
66 :undoc-members:
77 :show-inheritance:
8+ :no-index:
89
910Submodules
1011----------
@@ -17,6 +18,7 @@ pyppur.objectives.base module
1718 :undoc-members:
1819 :show-inheritance:
1920 :exclude-members: BaseObjective, Objective
21+ :no-index:
2022
2123pyppur.objectives.distance module
2224~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -26,6 +28,7 @@ pyppur.objectives.distance module
2628 :undoc-members:
2729 :show-inheritance:
2830 :exclude-members: DistanceObjective
31+ :no-index:
2932
3033pyppur.objectives.reconstruction module
3134~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -34,4 +37,5 @@ pyppur.objectives.reconstruction module
3437 :members:
3538 :undoc-members:
3639 :show-inheritance:
37- :exclude-members: ReconstructionObjective
40+ :exclude-members: ReconstructionObjective
41+ :no-index:
Original file line number Diff line number Diff line change @@ -5,6 +5,7 @@ pyppur.optimizers package
55 :members:
66 :undoc-members:
77 :show-inheritance:
8+ :no-index:
89
910Submodules
1011----------
@@ -17,6 +18,7 @@ pyppur.optimizers.base module
1718 :undoc-members:
1819 :show-inheritance:
1920 :exclude-members: BaseOptimizer
21+ :no-index:
2022
2123pyppur.optimizers.scipy_optimizer module
2224~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -26,6 +28,7 @@ pyppur.optimizers.scipy_optimizer module
2628 :undoc-members:
2729 :show-inheritance:
2830 :exclude-members: ScipyOptimizer
31+ :no-index:
2932
3033pyppur.optimizers.grid_optimizer module
3134~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -34,4 +37,5 @@ pyppur.optimizers.grid_optimizer module
3437 :members:
3538 :undoc-members:
3639 :show-inheritance:
37- :exclude-members: GridOptimizer
40+ :exclude-members: GridOptimizer
41+ :no-index:
Original file line number Diff line number Diff line change @@ -5,6 +5,7 @@ pyppur package
55 :members:
66 :undoc-members:
77 :show-inheritance:
8+ :no-index:
89
910Subpackages
1011-----------
Original file line number Diff line number Diff line change @@ -16,6 +16,7 @@ pyppur.utils.metrics module
1616 :members:
1717 :undoc-members:
1818 :show-inheritance:
19+ :no-index:
1920
2021pyppur.utils.preprocessing module
2122~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -24,11 +25,13 @@ pyppur.utils.preprocessing module
2425 :members:
2526 :undoc-members:
2627 :show-inheritance:
28+ :no-index:
2729
2830pyppur.utils.visualization module
2931~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3032
3133.. automodule :: pyppur.utils.visualization
3234 :members:
3335 :undoc-members:
34- :show-inheritance:
36+ :show-inheritance:
37+ :no-index:
You can’t perform that action at this time.
0 commit comments