Skip to content

Commit 7545e3c

Browse files
committed
docs: Enhance documentation and code structure
- Added a new tutorial path for warmstart in tutorials.rst. - Removed outdated example links from constraint.rst and loss.rst. - Improved the organization of loss function descriptions in loss.rst, including clearer sections for classification and regression losses. - Updated example links for various loss functions to point to the correct notebooks. - Refactored import order in _sklearn_mixin.py for consistency. - Enhanced docstrings in the plq_Ridge_Classifier and plq_ElasticNet_Classifier classes for better clarity. - Cleaned up code formatting and removed unnecessary whitespace in _sklearn_mixin.py.
1 parent e130e66 commit 7545e3c

26 files changed

Lines changed: 10818 additions & 13273 deletions

doc/source/_examples_toctree.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
:orphan:
2+
3+
.. toctree::
4+
:hidden:
5+
6+
examples/QR.ipynb
7+
examples/QR_eps.ipynb
8+
examples/CQR.ipynb
9+
examples/SVM.ipynb
10+
examples/FairSVM.ipynb
11+
examples/SVR.ipynb
12+
examples/RankRegression.ipynb
13+
examples/Path_solution.ipynb
14+
examples/Warm_start.ipynb
15+
examples/Sklearn_Mixin.ipynb
16+
examples/Multiclass_Classification.ipynb
17+
examples/NMF.ipynb
18+
examples/Smooth_SVM.ipynb
19+
examples/MonotonicSVM.ipynb
20+
examples/Squared_SVM.ipynb
21+
examples/Huber.ipynb
22+
examples/MAE.ipynb
23+
examples/MSE.ipynb
24+
examples/CustomQR.ipynb
25+
examples/GridSearchCV_SVM_losses.ipynb
26+
examples/GridSearchCV_reg_losses.ipynb
27+
examples/ElasticNet.ipynb

doc/source/example.rst

Lines changed: 5 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -21,57 +21,14 @@ Example Gallery
2121
examples/Multiclass_Classification.ipynb
2222
examples/NMF.ipynb
2323

24-
examples/Smooth_SVM_new.ipynb
24+
examples/Smooth_SVM.ipynb
2525
examples/MonotonicSVM.ipynb
26-
examples/SVM_new.ipynb
27-
examples/Squared_SVM_new.ipynb
28-
examples/QR_new.ipynb
29-
examples/QR_eps_new.ipynb
30-
examples/Huber_new.ipynb
31-
examples/SVR_new.ipynb
32-
examples/MAE_new.ipynb
33-
examples/MSE_new.ipynb
34-
examples/FairSVM_new.ipynb
26+
examples/Squared_SVM.ipynb
27+
examples/Huber.ipynb
28+
examples/MAE.ipynb
29+
examples/MSE.ipynb
3530
examples/CustomQR.ipynb
3631
examples/GridSearchCV_SVM_losses.ipynb
3732
examples/GridSearchCV_reg_losses.ipynb
3833

3934
examples/ElasticNet.ipynb
40-
main
41-
42-
List of Examples
43-
----------------
44-
45-
.. toctree::
46-
:maxdepth: 1
47-
48-
examples/QR.ipynb
49-
examples/QR_eps.ipynb
50-
examples/CQR.ipynb
51-
examples/SVM.ipynb
52-
examples/FairSVM.ipynb
53-
examples/SVR.ipynb
54-
examples/RankRegression.ipynb
55-
examples/Path_solution.ipynb
56-
examples/Warm_start.ipynb
57-
examples/Sklearn_Mixin.ipynb
58-
examples/Multiclass_Classification.ipynb
59-
examples/NMF.ipynb
60-
61-
examples/Smooth_SVM_new.ipynb
62-
examples/MonotonicSVM.ipynb
63-
examples/SVM_new.ipynb
64-
examples/Squared_SVM_new.ipynb
65-
examples/QR_new.ipynb
66-
examples/QR_eps_new.ipynb
67-
examples/Huber_new.ipynb
68-
examples/SVR_new.ipynb
69-
examples/MAE_new.ipynb
70-
examples/MSE_new.ipynb
71-
examples/FairSVM_new.ipynb
72-
examples/CustomQR.ipynb
73-
examples/GridSearchCV_SVM_losses.ipynb
74-
examples/GridSearchCV_reg_losses.ipynb
75-
76-
examples/ElasticNet.ipynb
77-
main

0 commit comments

Comments
 (0)