Skip to content

Commit becb142

Browse files
committed
Improve documentation and code formatting
- Remove unnecessary backslash escapes in RST attribute names - Fix trailing whitespace and add missing blank lines - Reformat function signatures for better readability - Update math notation to use k instead of r for rank - Simplify constraint notation in plqMF_Ridge docstring - Expand loss and constraint tutorial documentation
1 parent 08a6a8d commit becb142

2 files changed

Lines changed: 7 additions & 10 deletions

File tree

doc/source/autoapi/rehline/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -669,8 +669,8 @@ Classes
669669
This wrapper adds standard sklearn conveniences while delegating loss/constraint construction
670670
to :class:`plqERM_Ridge` (via `_make_loss_rehline_param` / `_make_constraint_rehline_param`).
671671

672-
Key behavior
673-
------------
672+
Notes
673+
-----
674674
- **Intercept handling**: if ``fit_intercept=True``, a constant column (value = ``intercept_scaling``)
675675
is appended to the right of the design matrix before calling the base solver. The last learned
676676
coefficient is then split out as ``intercept_``.

doc/source/index.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
.. _downloads: https://pepy.tech/project/rehline
2828

2929

30-
**ReHLine** is designed to be a computationally efficient and practically useful software package for large-scale ERMs.
30+
**ReHLine** is designed to be a computationally efficient and practically useful software package for large-scale ERMs.
3131

3232
- Homepage: `https://rehline.github.io/ <https://rehline.github.io/>`_
3333
- GitHub repo: `https://github.com/softmin/ReHLine-python <https://github.com/softmin/ReHLine-python>`_
@@ -48,15 +48,12 @@ The proposed **ReHLine** solver has appealing exhibits appealing properties:
4848
* - **Super-Efficient**
4949
- The optimization algorithm has a provable **LINEAR** convergence rate, and the per-iteration computational complexity is **LINEAR** in the sample size.
5050

51-
✨ New Features: Scikit-Learn Compatible Estimators
52-
---------------------------------------------------
51+
📰 News
52+
-------
5353

54-
We are excited to introduce full scikit-learn compatibility! `ReHLine` now provides `plq_Ridge_Classifier` and `plq_Ridge_Regressor` estimators that integrate seamlessly with the entire scikit-learn ecosystem.
54+
- **[2026-01] Monotonic Constraints**: We added support for monotonic constraints (both increasing and decreasing) in our solvers. See :doc:`tutorials/constraint` for details.
55+
- **[2025-11] Scikit-Learn Compatibility**: We introduced full scikit-learn compatibility! `ReHLine` now provides `plq_Ridge_Classifier` and `plq_Ridge_Regressor` estimators that integrate seamlessly with the entire scikit-learn ecosystem. This means you can drop `ReHLine` estimators directly into your existing scikit-learn `Pipeline`, perform robust hyperparameter tuning using `GridSearchCV`, and use standard evaluation metrics. See :doc:`tutorials/ReHLine_sklearn` for details.
5556

56-
This means you can:
57-
- Drop `ReHLine` estimators directly into your existing scikit-learn `Pipeline`.
58-
- Perform robust hyperparameter tuning using `GridSearchCV`.
59-
- Use standard scikit-learn evaluation metrics and cross-validation tools.
6057

6158
🔨 Installation
6259
---------------

0 commit comments

Comments
 (0)