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 references for R2 and LBFGS in readme #236 #259

Merged
merged 10 commits into from
Mar 8, 2024

Conversation

hpmouton
Copy link
Contributor

@hpmouton hpmouton commented Mar 5, 2024

This pull request addresses issue #236 by adding references for the R2 and LBFGS implementations in the project's readme.

Changes Made:

  • Added references for the R2 implementation in the readme.
  • Included references for the LBFGS implementation in the readme.

Related Issue:
Closes #236

@tmigot
Copy link
Member

tmigot commented Mar 5, 2024

Thanks @hpmouton for the suggestion! I really like the idea.

@dpo or @d-monnet Would you have some time to check if that's the "right" references?

Copy link

codecov bot commented Mar 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.48%. Comparing base (bd12646) to head (d24ec90).

❗ Current head d24ec90 differs from pull request most recent head a228529. Consider uploading reports for the commit a228529 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #259   +/-   ##
=======================================
  Coverage   88.48%   88.48%           
=======================================
  Files           7        7           
  Lines        1025     1025           
=======================================
  Hits          907      907           
  Misses        118      118           

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

Copy link
Contributor

github-actions bot commented Mar 5, 2024

Package name latest stable
FletcherPenaltySolver.jl
Percival.jl

@d-monnet
Copy link
Contributor

d-monnet commented Mar 5, 2024

Thanks @hpmouton for the suggestion! I really like the idea.

@dpo or @d-monnet Would you have some time to check if that's the "right" references?

As far as I know, there's no reference for R2 itself. I'm not sure our paper with D. Orban is the most relevant reference, I'll let @dpo decide what reference is the most appropriate.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Added suggested citations.
Copy link
Member

@dpo dpo left a comment

Choose a reason for hiding this comment

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

Thank you! Just a minor final comment.

README.md Show resolved Hide resolved
Indentations fixed.
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
hpmouton and others added 2 commits March 8, 2024 11:47
Co-authored-by: Dominique <[email protected]>
Commited dpo sugesstions

Co-authored-by: Dominique <[email protected]>
@dpo dpo merged commit 8f11bf9 into JuliaSmoothOptimizers:main Mar 8, 2024
18 checks passed
@dpo
Copy link
Member

dpo commented Mar 8, 2024

Thank you!

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.

Add references for R2 and LBFGS in readme
4 participants