Skip to content

Commit 8f6ef7f

Browse files
committed
add details
1 parent ed7e038 commit 8f6ef7f

6 files changed

Lines changed: 412 additions & 8 deletions

File tree

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
<!-- A clear and concise description of what the bug is -->
12+
13+
## Expected Behavior
14+
15+
<!-- What you expected to happen -->
16+
17+
## Actual Behavior
18+
19+
<!-- What actually happened -->
20+
21+
## Steps to Reproduce
22+
23+
<!-- Steps to reproduce the bug -->
24+
1.
25+
2.
26+
3.
27+
28+
## Minimal Code Example
29+
30+
```python
31+
# Minimal reproducible example
32+
import numpy as np
33+
from rehline import ReHLine
34+
35+
# Your code here
36+
```
37+
38+
## Environment
39+
40+
- OS:
41+
- Python version:
42+
- ReHLine version:
43+
- NumPy version:
44+
- SciPy version:
45+
- scikit-learn version:
46+
47+
## Additional Context
48+
49+
<!-- Add any other context about the problem -->
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or improvement
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
<!-- A clear and concise description of the feature -->
12+
13+
## Use Case
14+
15+
<!-- What's the problem you're trying to solve? Why do you need this feature? -->
16+
17+
## Proposed Solution
18+
19+
<!-- How do you think this could be implemented -->
20+
21+
## Alternative Solutions
22+
23+
<!-- Any alternative solutions you've considered -->
24+
25+
## Additional Context
26+
27+
<!-- Add any other context, screenshots, or mockups about the feature request -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Description
2+
3+
<!-- Briefly describe what this PR does -->
4+
5+
## Related Issue
6+
7+
<!-- Link to related issue: Fixes #123 -->
8+
9+
## Type of Change
10+
11+
- [ ] Bug fix (non-breaking change that fixes an issue)
12+
- [ ] New feature (non-breaking change that adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Refactoring
16+
- [ ] Other: <!-- describe -->
17+
18+
## Checklist
19+
20+
- [ ] I have tested my changes locally
21+
- [ ] Tests pass: `pytest tests/ -v`
22+
- [ ] Code follows the style guidelines (PEP 8)
23+
- [ ] Documentation has been updated (if applicable)
24+
- [ ] Commits are properly formatted
25+
26+
## Additional Notes
27+
28+
<!-- Add any additional context about the PR -->

CHANGELOG.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## [0.1.1] - 2025-10-07
11+
12+
### Added
13+
14+
- Support for monotonic constraints (both increasing and decreasing) in solvers
15+
- Monotonic constraint documentation and tutorials
16+
17+
### Fixed
18+
19+
- Various bug fixes and improvements
20+
21+
## [0.1.0] - 2025-06-10
22+
23+
### Added
24+
25+
- Full scikit-learn compatibility with `plq_Ridge_Classifier` and `plq_Ridge_Regressor`
26+
- Integration with scikit-learn `Pipeline`
27+
- Support for `GridSearchCV` and standard evaluation metrics
28+
29+
### Changed
30+
31+
- Improved documentation and tutorials
32+
33+
## [0.0.7] - 2025-06-10
34+
35+
### Added
36+
37+
- Multi-class classification support
38+
- ElasticNet penalty support for `plqERM`
39+
- ElasticNet penalty support for ReHLine solver
40+
41+
### Fixed
42+
43+
- Various bug fixes and improvements
44+
45+
## [0.0.6] - 2025-01-14
46+
47+
### Added
48+
49+
- Matrix factorization support with `plqMF_Ridge` class
50+
- `make_mf_dataset` function for matrix factorization datasets
51+
52+
### Changed
53+
54+
- Updated dependencies
55+
56+
## [0.0.5] - 2024-10-31
57+
58+
### Added
59+
60+
- Additional features and improvements
61+
62+
### Changed
63+
64+
- Documentation improvements and code formatting
65+
66+
## [0.0.4] - 2024-09-03
67+
68+
### Added
69+
70+
- Additional features and improvements
71+
72+
### Changed
73+
74+
- Dependency updates
75+
76+
## [0.0.3] - 2024-04-24
77+
78+
### Added
79+
80+
- Core solver improvements and bug fixes
81+
82+
## [0.0.1] - 2023-10-18
83+
84+
### Added
85+
86+
- Initial release of ReHLine Python package
87+
- ReHLine solver for regularized composite ReLU-ReHU loss minimization
88+
- Support for convex piecewise linear-quadratic loss functions
89+
- Linear equality and inequality constraints support
90+
- Ridge regression and classification estimators
91+
92+
[Unreleased]: https://github.com/softmin/ReHLine-python/compare/v0.1.1...HEAD
93+
[0.1.1]: https://github.com/softmin/ReHLine-python/compare/v0.1.0...v0.1.1
94+
[0.1.0]: https://github.com/softmin/ReHLine-python/compare/v0.0.7...v0.1.0
95+
[0.0.7]: https://github.com/softmin/ReHLine-python/compare/v0.0.6...v0.0.7
96+
[0.0.6]: https://github.com/softmin/ReHLine-python/compare/v0.0.5...v0.0.6
97+
[0.0.5]: https://github.com/softmin/ReHLine-python/compare/v0.0.4...v0.0.5
98+
[0.0.4]: https://github.com/softmin/ReHLine-python/compare/v0.0.3...v0.0.4
99+
[0.0.3]: https://github.com/softmin/ReHLine-python/compare/v0.0.1...v0.0.3
100+
[0.0.1]: https://github.com/softmin/ReHLine-python/tree/v0.0.1

0 commit comments

Comments
 (0)