Skip to content

Commit 964b747

Browse files
committed
docs(tutorials): remove outdated tutorial entries and reorder toctree
Remove ReHLine ERM and Ridge Composite Quantile Regression entries from the tutorials list and reorder the toctree for consistency. Also add local/ directory to .gitignore.
1 parent 6ff2348 commit 964b747

2 files changed

Lines changed: 5 additions & 12 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,6 @@ eigen3.zip
3838
# python checkpoint
3939
*-checkpoint.ipynb
4040
*-checkpoint.py
41+
42+
# local
43+
local/

doc/source/tutorials.rst

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,10 @@ List of Tutorials
3737
- | `ReHLine <./autoapi/rehline/index.html#rehline.ReHLine>`_
3838
- | ReHLine minimization with manual parameter settings.
3939

40-
* - `ReHLine: Empirical Risk Minimization <./tutorials/ReHLine_ERM.rst>`_
41-
- | `plqERM_Ridge <./autoapi/rehline/index.html#rehline.plqERM_Ridge>`_
42-
- | Empirical Risk Minimization (ERM) with a piecewise linear-quadratic (PLQ) objective with a ridge penalty.
43-
4440
* - `ReHLine: Scikit-learn Compatible Estimators <./tutorials/ReHLine_sklearn.rst>`_
4541
- | `plq_Ridge_Classifier <./autoapi/rehline/index.html#rehline.plq_Ridge_Classifier>`_ `plq_Ridge_Regressor <./autoapi/rehline/index.html#rehline.plq_Ridge_Regressor>`_
4642
- | Scikit-learn compatible estimators framework for empirical risk minimization problem.
4743

48-
* - `ReHLine: Ridge Composite Quantile Regression <./examples/CQR.ipynb>`_
49-
- | `CQR_Ridge <./autoapi/rehline/index.html#rehline.CQR_Ridge>`_
50-
- | Composite Quantile Regression (CQR) with a ridge penalty.
51-
5244
* - `ReHLine: Matrix Factorization <./tutorials/ReHLine_MF.rst>`_
5345
- | `plqMF_Ridge <./autoapi/rehline/index.html#rehline.plqMF_Ridge>`_
5446
- | Matrix Factorization (MF) with a piecewise linear-quadratic (PLQ) objective with a ridge penalty.
@@ -58,10 +50,8 @@ List of Tutorials
5850
:hidden:
5951

6052
./tutorials/ReHLine_manual
61-
./tutorials/ReHLine_ERM
62-
./tutorials/loss
63-
./tutorials/constraint
6453
./tutorials/ReHLine_sklearn
65-
./tutorials/warmstart
6654
./tutorials/ReHLine_MF
55+
./tutorials/loss
56+
./tutorials/constraint
6757

0 commit comments

Comments
 (0)