Skip to content

Documentation for nonlinear least squares (NLS) problems#411

Open
arnavk23 wants to merge 5 commits intoJuliaSmoothOptimizers:mainfrom
arnavk23:docs-fix-issue-162-mainonly
Open

Documentation for nonlinear least squares (NLS) problems#411
arnavk23 wants to merge 5 commits intoJuliaSmoothOptimizers:mainfrom
arnavk23:docs-fix-issue-162-mainonly

Conversation

@arnavk23
Copy link
Copy Markdown
Contributor

@arnavk23 arnavk23 commented Mar 15, 2026

Closes #162
@dpo @tmigot

…ssification, implementation, and usage for contributors and users.
@tmigot tmigot self-requested a review March 17, 2026 15:04
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 54.34%. Comparing base (2ada450) to head (eaa79f9).
⚠️ Report is 46 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #411       +/-   ##
===========================================
- Coverage   99.80%   54.34%   -45.47%     
===========================================
  Files        1084     1138       +54     
  Lines       12319    13371     +1052     
===========================================
- Hits        12295     7266     -5029     
- Misses         24     6105     +6081     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@arnavk23 arnavk23 requested a review from tmigot March 30, 2026 21:22
Co-authored-by: Tangi Migot <tangi.migot@gmail.com>
Copilot AI review requested due to automatic review settings April 1, 2026 10:18
Copy link
Copy Markdown

Copilot AI left a 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 updates the documentation to better explain how nonlinear least squares (NLS) problems are represented and accessed in OptimizationProblems.jl, and fixes a couple of tutorial typos.

Changes:

  • Add NLS user-facing documentation to the tutorial and metadata pages (including how to filter NLS problems and query *_nls_nequ).
  • Add contributor guidelines for implementing NLS problems.
  • Fix minor wording/typos in existing docs.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
docs/src/tutorial.md Adds a new NLS section describing use_nls=true usage and discovery via meta.
docs/src/meta.md Documents the :objtype == :least_squares classification and get_*_nls_nequ() getters; adds filtering example.
docs/src/contributing.md Adds contributor guidance for adding NLS problems (metadata + getters + construction pattern).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

arnavk23 added 2 commits April 3, 2026 02:07
Removed guidelines for Nonlinear Least Squares (NLS) problems from the contributing documentation.
@arnavk23 arnavk23 requested a review from tmigot April 2, 2026 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Nonlinear least squares

3 participants