Skip to content

Commit 3fc9942

Browse files
ruslansenatorovruslansenatorov
authored
Add files via upload
Signed-off-by: Ruslan Senatorov <55090151+ruslansenatorov@users.noreply.github.com>
1 parent d2694ac commit 3fc9942

10 files changed

Lines changed: 1048 additions & 0 deletions

File tree

‎CITATION.cff‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
cff-version: 1.2.0
2+
message: "If you use this project in research or academic work, please cite it using the information below."
3+
4+
title: "Normal Equations Solver for Simple Linear Regression"
5+
6+
version: "0.1.0"
7+
8+
doi: "10.5281/zenodo.18818738"
9+
10+
date-released: "2026-03-01"
11+
12+
repository-code: "https://github.com/USERNAME/Normal-equations-solver-simple-linear-regression"
13+
14+
license: MIT
15+
16+
authors:
17+
- family-names: "Senatorov"
18+
given-names: "Ruslan"
19+
orcid: ""
20+
email: "t.me/RuslanSenatorov or youtube.com/SENATOROV"
21+
affiliation: "Independent Research"
22+
23+
keywords:
24+
- optimization
25+
- Normal Equations
26+
- numerical-optimization
27+
- large-scale-optimization
28+
- machine-learning
29+
- Simple Linear Regression
30+
31+
abstract: >
32+
This project provides a mathematically rigorous treatment and
33+
production-style implementation of the Normal Equations
34+
optimization algorithm, including theoretical derivation,
35+
convergence analysis, and numerical experiments.
36+
37+
preferred-citation:
38+
type: report
39+
doi: "10.5281/zenodo.18818738"
40+
title: "L-BFGS Solver Course"
41+
authors:
42+
- family-names: "Senatorov"
43+
given-names: "Ruslan"
44+
year: 2026
45+
repository-code: "https://github.com/USERNAME/Normal-equations-solver-simple-linear-regression"
46+
47+
48+

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to the **Solver Course** project.
4+
5+
We welcome improvements in:
6+
7+
- Mathematical derivations
8+
- Algorithm correctness
9+
- Numerical stability
10+
- Code quality
11+
- Benchmarking
12+
- Documentation
13+
- Tests
14+
- Performance improvements
15+
16+
---
17+
18+
## Project Philosophy
19+
20+
This repository follows these principles:
21+
22+
- Mathematical correctness first
23+
- Reproducible experiments
24+
- Clean and readable implementation
25+
- Minimal dependencies
26+
- Transparent optimization logic
27+
28+
All contributions must respect these principles.
29+
30+
---
31+
32+
## How to Contribute
33+
34+
### 1. Fork the Repository
35+
36+
Fork the project and clone your fork locally:
37+
38+
```bash
39+
git clone https://github.com/<your-username>/name-solver-course.git
40+
cd name-solver-course
41+
42+
---
43+
44+
### 2. Create a Feature Branch
45+
46+
Always create a new branch for changes:
47+
48+
```bash
49+
git checkout -b feature/your-feature-name
50+
```
51+
52+
Branch naming examples:
53+
54+
* `feature/improve-two-loop`
55+
* `feature/add-benchmark`
56+
* `fix/line-search-bug`
57+
* `docs/improve-theory`
58+
59+
---
60+
61+
### 3. Follow Code Standards
62+
63+
* Use clear variable names
64+
* Add docstrings to functions
65+
* Keep functions small and modular
66+
* Avoid unnecessary abstraction
67+
68+
Python style:
69+
70+
```bash
71+
black .
72+
flake8 .
73+
pytest
74+
```
75+
76+
---
77+
78+
### 4. Add Tests (If Applicable)
79+
80+
If your contribution modifies solver logic:
81+
82+
* Add unit tests in `tests/`
83+
* Test numerical stability
84+
* Test convergence on quadratic functions
85+
86+
Pull requests without tests (for code changes) may require review discussion.
87+
88+
---
89+
90+
### 5. Update Documentation
91+
92+
If you modify:
93+
94+
* Algorithm behavior → Update theory docs
95+
* API → Update README
96+
* Implementation → Update documentation accordingly
97+
98+
Documentation must reflect code changes.
99+
100+
---
101+
102+
## Pull Request Process
103+
104+
1. Push your branch:
105+
106+
```bash
107+
git push origin feature/your-feature-name
108+
```
109+
110+
2. Open a Pull Request.
111+
112+
3. Include:
113+
114+
* Description of change
115+
* Motivation
116+
* Benchmark results (if performance changes)
117+
* Test results
118+
119+
---
120+
121+
## Code Review Criteria
122+
123+
Your PR will be reviewed based on:
124+
125+
* Mathematical correctness
126+
* Numerical stability
127+
* Clean implementation
128+
* Test coverage
129+
* Documentation clarity
130+
131+
---
132+
133+
## Reporting Issues
134+
135+
If you find:
136+
137+
* Mathematical inconsistency
138+
* Implementation bug
139+
* Performance regression
140+
* Documentation error
141+
142+
Open an Issue with:
143+
144+
* Clear description
145+
* Minimal reproducible example
146+
* Expected vs actual behavior
147+
148+
---
149+
150+
## Code of Conduct
151+
152+
Be respectful and constructive.
153+
154+
Focus on:
155+
156+
* Technical discussion
157+
* Algorithm improvement
158+
* Scientific correctness
159+
160+
---
161+
162+
Thank you for improving the project
163+

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 SenatorovAI - Школа Data Science
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)