Skip to content
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

Add support for JFNK #201

Merged
merged 6 commits into from
Aug 22, 2023
Merged

Add support for JFNK #201

merged 6 commits into from
Aug 22, 2023

Conversation

avik-pal
Copy link
Member

No description provided.

Copy link

@ai-maintainer ai-maintainer bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI-Maintainer Review for PR - Add support for JFNK

Title and Description ❌

Needs Improvement
The title of the pull request is clear and indicates the purpose of the changes. However, the description is empty and does not provide any additional context or explanation. It would be helpful to have a description that elaborates on the motivation behind adding JFNK support and any relevant details about the implementation.

Scope ✅

Good
The changes appear to be narrowly focused on adding support for JFNK. The diff primarily consists of additions related to JFNK support, such as adding the `LinearSolve` package to the project dependencies and modifying various files to include `LinearSolve` in the test targets. There are also changes to specific files related to implementing JFNK methods, such as `jacobian.jl`, `levenberg.jl`, `raphson.jl`, `trustRegion.jl`, and `utils.jl`.

Testing ❌

Needs Improvement
The description of the pull request does not provide any information about how the author tested the changes. It would be beneficial to have a description that outlines the testing approach taken by the author, such as specific test cases, test environments, or any relevant test results.

Documentation ❌

Needs Improvement
The following functions, classes, or methods have been added without docstrings:
  • build_jac_and_jac_config
  • jacobian_caches (in levenberg.jl, raphson.jl, trustRegion.jl)
  • dolinsolve (in utils.jl)
  • benchmark_inplace (in basictests.jl)

These additions should be accompanied by appropriate docstrings to describe their behavior, arguments, and return values.

Suggested Changes

  • Please add a detailed description to the pull request explaining the motivation behind these changes and how they were implemented.
  • Please add docstrings to the newly added functions, classes, or methods to describe their behavior, arguments, and return values.
  • Please provide information about how the changes were tested. This could include specific test cases that were run, the test environments used, and any relevant test results.

Reviewed with AI Maintainer

@codecov
Copy link

codecov bot commented Aug 21, 2023

Codecov Report

Merging #201 (c006772) into master (e93fc58) will increase coverage by 0.67%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #201      +/-   ##
==========================================
+ Coverage   93.75%   94.42%   +0.67%     
==========================================
  Files           7        7              
  Lines         720      699      -21     
==========================================
- Hits          675      660      -15     
+ Misses         45       39       -6     
Files Changed Coverage Δ
src/NonlinearSolve.jl 100.00% <ø> (ø)
src/levenberg.jl 95.71% <ø> (-0.37%) ⬇️
src/raphson.jl 97.10% <ø> (-0.52%) ⬇️
src/trustRegion.jl 96.81% <ø> (-0.14%) ⬇️
src/utils.jl 81.42% <ø> (+7.14%) ⬆️
src/jacobian.jl 90.81% <100.00%> (+3.63%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@avik-pal
Copy link
Member Author

Ok definitely broke something 😓

src/jacobian.jl Outdated Show resolved Hide resolved
src/levenberg.jl Outdated Show resolved Hide resolved
src/raphson.jl Outdated Show resolved Hide resolved
src/trustRegion.jl Outdated Show resolved Hide resolved
src/trustRegion.jl Outdated Show resolved Hide resolved
test/basictests.jl Outdated Show resolved Hide resolved
@avik-pal
Copy link
Member Author

@ChrisRackauckas can you rerun the integration test, it somehow got cancelled https://github.com/SciML/NonlinearSolve.jl/actions/runs/5941975798/job/16113962425?pr=201#step:6:1070

@ChrisRackauckas
Copy link
Member

I think it's fine.

@ChrisRackauckas ChrisRackauckas merged commit aedd385 into SciML:master Aug 22, 2023
11 of 13 checks passed
@avik-pal avik-pal deleted the ap/jnfk branch August 22, 2023 21:07
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.

2 participants