Skip to content

Commit 7e733db

Browse files
committed
add citation and contributing files
1 parent af2d79c commit 7e733db

3 files changed

Lines changed: 92 additions & 0 deletions

File tree

CITATION.cff

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
cff-version: 1.2.0
2+
message: "If you use ReHLine in your research, please cite it as follows:"
3+
title: "ReHLine: Efficient Solver for ERM with PLQ Loss and Linear Constraints"
4+
version: 1.0.0
5+
date-released: 2023-12-01
6+
url: "https://github.com/softmin/ReHLine"
7+
repository-code: "https://github.com/softmin/ReHLine-python"
8+
documentation: "https://rehline-python.readthedocs.io"
9+
license: MIT
10+
authors:
11+
- family-names: "Dai"
12+
given-names: "Ben"
13+
- family-names: "Qiu"
14+
given-names: "Yixuan"
15+
keywords:
16+
- optimization
17+
- machine learning
18+
- empirical risk minimization
19+
- convex optimization
20+
- support vector machines
21+
- quantile regression
22+
preferred-citation:
23+
type: conference-paper
24+
title: "ReHLine: Regularized Composite ReLU-ReHU Loss Minimization with Linear Computation and Linear Convergence"
25+
authors:
26+
- family-names: "Dai"
27+
given-names: "Ben"
28+
- family-names: "Qiu"
29+
given-names: "Yixuan"
30+
conference:
31+
name: "Thirty-seventh Conference on Neural Information Processing Systems"
32+
year: 2023
33+
url: "https://openreview.net/pdf?id=3pEBW2UPAD"
34+
ENDOFFILE; __hermes_rc=$?; printf '__HERMES_FENCE_a9f7b3__'; exit $__hermes_rc

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing to ReHLine
2+
3+
## Getting Started
4+
5+
1. Fork and clone: `git clone https://github.com/your-username/ReHLine-python.git`
6+
2. Install: `pip install -e .`
7+
8+
## Making Changes
9+
10+
1. Create a branch for your feature/fix
11+
2. Add tests for new functionality
12+
3. Run tests: `pytest tests/ -v`
13+
4. Submit a pull request
14+
15+
## Reporting Issues
16+
17+
- Bug reports: include steps to reproduce, expected vs actual behavior, and a minimal code example
18+
- Feature requests: describe the use case and proposed API
19+
20+
## License
21+
22+
By contributing, you agree that your contributions will be licensed under the MIT License.

SECURITY.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
| ------- | ------------------ |
7+
| 0.1.x | :white_check_mark: |
8+
| < 0.1.0 | :x: |
9+
10+
## Reporting a Vulnerability
11+
12+
If you discover a security vulnerability in ReHLine, please report it responsibly:
13+
14+
1. **Do not** open a public issue
15+
2. Email the maintainers directly at: bendai@cuhk.edu.hk
16+
3. Include:
17+
- Description of the vulnerability
18+
- Steps to reproduce
19+
- Potential impact
20+
- Suggested fix (if any)
21+
22+
## Response Timeline
23+
24+
- **Acknowledgment**: Within 48 hours
25+
- **Assessment**: Within 1 week
26+
- **Fix & Release**: As soon as possible, depending on severity
27+
28+
## Security Best Practices
29+
30+
When using ReHLine:
31+
32+
- Keep dependencies up to date
33+
- Validate input data before passing to solvers
34+
- Use appropriate constraints to prevent numerical issues
35+
- Report any unexpected behavior that might indicate a security issue
36+
ENDOFFILE; __hermes_rc=$?; printf '__HERMES_FENCE_a9f7b3__'; exit $__hermes_rc

0 commit comments

Comments
 (0)