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 Manopt to list of solvers #3568

Merged
merged 8 commits into from
Nov 16, 2023
Merged

Add Manopt to list of solvers #3568

merged 8 commits into from
Nov 16, 2023

Conversation

blegat
Copy link
Member

@blegat blegat commented Nov 8, 2023

cc @kellertuer @mateuszbaran

Basic

  • Check that the solver is a registered Julia package
  • 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: https://manoptjl.org/stable/extensions.html#JuMP.jl

Documentation

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

Optional

  • Add package metadata to docs/packages.toml

Copy link

codecov bot commented Nov 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b13812d) 98.38% compared to head (af86060) 98.38%.
Report is 3 commits behind head on master.

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

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3568   +/-   ##
=======================================
  Coverage   98.38%   98.38%           
=======================================
  Files          37       37           
  Lines        5624     5629    +5     
=======================================
+ Hits         5533     5538    +5     
  Misses         91       91           

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

@kellertuer
Copy link

How does documenter check for the Readme and why is that needed? Currently it looks for

https://raw.githubusercontent.com/JuliaManifolds/Manopt.jl/v0.4.42/README.md

but we left the 80s and the rule to capitalise everything and have

https://raw.githubusercontent.com/JuliaManifolds/Manopt.jl/v0.4.42/Readme.md

docs/packages.toml Outdated Show resolved Hide resolved
Co-authored-by: Ronny Bergmann <[email protected]>
docs/packages.toml Outdated Show resolved Hide resolved
Co-authored-by: Ronny Bergmann <[email protected]>
@odow
Copy link
Member

odow commented Nov 8, 2023

Preview: https://jump.dev/JuMP.jl/previews/PR3568/packages/Manopt/

I should just find a way to turn vale errors into warnings for external packages.

@kellertuer
Copy link

The preview looks nice! Yes, I do not understand which warnings and errors you have there – the first error says, Exclamation marks are not allowed? That is a super strict rule! (Oh! an error ;))

@odow
Copy link
Member

odow commented Nov 8, 2023

We run https://vale.sh with the Google style guide https://github.com/errata-ai/Google.

The typos can be fixed by adding them to the allow-list: https://github.com/jump-dev/JuMP.jl/blob/master/docs/styles/Vocab/JuMP-Vocab/accept.txt

For the exclaimation rule, see https://developers.google.com/style/periods#exclamation-points

@kellertuer
Copy link

Quite interesting, will keep that in mind – until now we only run code style tests, but this looks nice as well.

@odow
Copy link
Member

odow commented Nov 8, 2023

Opened a few changes here: JuliaManifolds/Manopt.jl#315

docs/packages.toml Outdated Show resolved Hide resolved
@odow odow merged commit 283a99d into master Nov 16, 2023
@odow odow deleted the bl/manopt branch November 16, 2023 01:47
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.

3 participants