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

[docs] Add Optim to list of solvers #3624

Merged
merged 8 commits into from Feb 5, 2024
Merged

[docs] Add Optim to list of solvers #3624

merged 8 commits into from Feb 5, 2024

Conversation

blegat
Copy link
Member

@blegat blegat commented Dec 12, 2023

Preview https://jump-dev.github.io/JuMP.jl/previews/PR3624

Basic

  • Check that the solver is a registered Julia package
  • Check that the MOI wrapper is part of the latest release
  • Check that the solver supports the long-term support release of Julia
  • Check that the solver has a MathOptInterface wrapper
  • Check that the tests call MOI.Test.runtests. Some test excludes are
    permissible, but the reason for skipping a particular test should be
    documented.
  • Check that the README and/or documentation provides an example of how to
    use the solver with JuMP Update README example to new MOI nonlinear interface JuliaNLSolvers/Optim.jl#1059

Documentation

  • Add a new row to the table in docs/src/installation.md

Optional

  • Add package metadata to docs/packages.toml

cc @pkofod

Copy link

codecov bot commented Dec 12, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9e2e263) 98.21% compared to head (5892707) 98.29%.
Report is 31 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3624      +/-   ##
==========================================
+ Coverage   98.21%   98.29%   +0.07%     
==========================================
  Files          43       43              
  Lines        5653     5676      +23     
==========================================
+ Hits         5552     5579      +27     
+ Misses        101       97       -4     

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

docs/packages.toml Outdated Show resolved Hide resolved
@odow
Copy link
Member

odow commented Feb 2, 2024

@blegat the issue now is that the Optim README doesn't conform to our needs: https://jump.dev/JuMP.jl/previews/PR3624/packages/Optim/

image

Perhaps we could just omit the README for now?

@pkofod
Copy link

pkofod commented Feb 2, 2024

the issue now is that the Optim README doesn't conform to our needs:

where can I find the requirements?

@odow
Copy link
Member

odow commented Feb 2, 2024

It needs to be documenter markdown, not GitHub markdown 😄

You can see from the image above. The links don't work, and it needs to be ```math instead of $$. It can be painful to get right. But I can take a look if you don't mind me making seeming pointless changes to the README just so JuMP can embed the README in our docs.

@pkofod
Copy link

pkofod commented Feb 2, 2024

It needs to be documenter markdown, not GitHub markdown 😄

You can see from the image above. The links don't work, and it needs to be ```math instead of $$. It can be painful to get right. But I can take a look if you don't mind me making seeming pointless changes to the README just so JuMP can embed the README in our docs.

If you have time! Otherwise I'll try to get to it early next week.

@odow
Copy link
Member

odow commented Feb 3, 2024

See JuliaNLSolvers/Optim.jl#1076

@pkofod
Copy link

pkofod commented Feb 5, 2024

docs/packages.toml Outdated Show resolved Hide resolved
@odow
Copy link
Member

odow commented Feb 5, 2024

@odow odow merged commit b7dec47 into master Feb 5, 2024
12 checks passed
@odow odow deleted the bl/optim branch February 5, 2024 23:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants