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

Update examples for JuMP/MOI and format them as doctests #1175

Closed
mlubin opened this issue Feb 4, 2018 · 5 comments

Comments

@mlubin
Copy link
Member

commented Feb 4, 2018

Using doctests would make sure the examples keep working over time. This addresses #699.

There are a couple open questions here.

  • What solvers should we use for testing?
  • We just went through a lot of work to make JuMP testable without solvers.... but using doctests would force us to depend on solvers in CI. A few options are:
    • Collapse JuMP/MOI/MOIU/MOIT into a single package and include one default solver.
    • Make a separate package called JuMPExamples.

I'm not entirely serious about collapsing JuMP/MOI/MOIU/MOIT into a single package, but if you look at any other modeling package like cvxpy, pyomo, etc., JuMP is an outlier in its modularity, and it results in weird situations like not having a solver available to run examples. I expect we'll go with JuMPExamples.

@joaquimg

This comment has been minimized.

Copy link
Member

commented Feb 4, 2018

+1 JuMPExamples

@joehuchette

This comment has been minimized.

Copy link
Member

commented Feb 4, 2018

Yeah, the single package idea is a little too drastic for me.

@mlubin

This comment has been minimized.

Copy link
Member Author

commented Feb 5, 2018

When updating the examples, let's keep a list of all the things that needed to be changed. That will help us develop a 0.18 -> 0.19 upgrading guide.

@mlubin

This comment has been minimized.

Copy link
Member Author

commented Feb 6, 2018

Other thing to remember is juliaopt-notebooks. They need to be updated or moved into JuMPExamples or marked as outdated (also the copies hosted on juliaopt.org).

@mlubin

This comment has been minimized.

Copy link
Member Author

commented Apr 6, 2018

Given that Pkg3 will allow multiple Julia packages in the same repository, I think we should hold off on making a new JuMPExamples.jl and just update them in place for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.