-
Notifications
You must be signed in to change notification settings - Fork 2
Docs: V0.2-tutorials/least squares example #134
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
…Algebra.jl into v0.2-tutorials
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive tutorial documentation, fixes a typo in documentation, and corrects a boundary condition bug in the logger's convergence check.
- Adds tutorial documentation covering consistent linear systems and least-squares problems
- Fixes typo in SparseSign compressor documentation ("fo" → "of")
- Corrects iteration boundary check in BasicLogger from
<=to<to prevent out-of-bounds errors
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/Solvers/Loggers/basic_logger.jl | Fixed off-by-one error in iteration comparison to prevent bounds errors |
| src/Compressors/sparse_sign.jl | Corrected typo in documentation comment |
| docs/src/tutorials/introduction.md | Added introduction page for tutorials with problem set overview |
| docs/src/tutorials/consistent_system/consistent_system.md | Added tutorial for solving consistent linear systems |
| docs/src/tutorials/consistent_system/consistent_system_configure.md | Added advanced tutorial showing modular customization of solvers |
| docs/src/tutorials/least_squares/least_squares.md | Added tutorial for solving least-squares problems |
| docs/src/tutorials/least_squares/least_squares_configure.md | Added placeholder for least-squares customization tutorial |
| docs/make.jl | Enabled tutorials section in documentation |
| .github/workflows/Documenter.yml | Simplified workflow triggers, removed obsolete branches |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Modular Customization: More Compressors | ||
|
|
||
|
|
||
| This doc will introduce more compressors, and left the other modules, |
Copilot
AI
Nov 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grammatical error: 'left' should be 'leave' to maintain proper verb tense consistency.
| This doc will introduce more compressors, and left the other modules, | |
| This doc will introduce more compressors, and leave the other modules, |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Description
Docs:
Motivation and Context
Refer to the JuMP.jl Tutorials section.
How has this been tested
First, download the RLinearAlgebra.jl to your local Julia environment.
Then, open Julia in the folder of RLinearAlgebra.jl, and use the following codes to see the document:
Types of changes
Checklists:
Code and Comments
If this PR includes modification to the code base, please select all that apply.
API Documentation
Manual Documentation
Testing
@code_lowered and
@code_typed)