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.

Sign up for GitHub

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

Jump to bottom

Automate testing of examples #1712

Merged
merged 19 commits into from
Jan 2, 2019
Merged

Automate testing of examples #1712

merged 19 commits into from
Jan 2, 2019

Conversation

odow
Copy link
Member

@odow odow commented Dec 29, 2018 •
edited
Loading

This PR adds a build stage to Linux/Julia 1.0 on Travis that runs the examples in /examples. This requires the installation of some solvers. So far, I have added GLPK (for LP/MIP), Ipopt (for NLP), and SCS (for SDP).

List of examples and whether they have been updated:

  • basic
  • cannery
  • cluster
  • corr_sdp
  • diet
  • knapsack
  • maxcut_sdp
  • mindistortion
  • minellipse
  • mle
  • multi
  • optcontrol
  • prod
  • qcp
  • robust_uncertainty
  • rosenbrock
  • steelT3
  • sudoku
  • transp
  • urbanplan

Closes #699
Closes #1175

  • PR currently includes Manifest.toml because latest GLPK tag isn't in METADATA. Once it is, we can remove Manifest.tom.

@codecov
Copy link

codecov bot commented Dec 29, 2018

Codecov Report

Merging #1712 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1712   +/-   ##
=======================================
  Coverage   68.69%   68.69%           
=======================================
  Files          30       30           
  Lines        3891     3891           
=======================================
  Hits         2673     2673           
  Misses       1218     1218

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cd8dbe5...5b167b3. Read the comment docs.

@codecov
Copy link

codecov bot commented Dec 29, 2018 •
edited
Loading

Codecov Report

Merging #1712 into master will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1712      +/-   ##
==========================================
+ Coverage   68.69%   68.72%   +0.02%     
==========================================
  Files          30       30              
  Lines        3891     3904      +13     
==========================================
+ Hits         2673     2683      +10     
- Misses       1218     1221       +3
Impacted Files Coverage Δ
src/copy.jl 76.31% <0%> (-1.47%) ⬇️
src/JuMP.jl 71.28% <0%> (+0.58%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cd8dbe5...8997c86. Read the comment docs.

mlubin
mlubin reviewed Dec 29, 2018
View reviewed changes
Copy link
Member

@mlubin mlubin left a comment

Choose a reason for hiding this comment

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

This is great. I like how we can see if JuMP is passing its tests (without solvers) separately from whether the examples pass.

A lot of the CI time is spent in Ipopt compilation. Hopefully we can switch to BinaryBuilder on linux soon...

examples/basic.jl Show resolved Hide resolved
mlubin
mlubin reviewed Dec 30, 2018
View reviewed changes
examples/mindistortion.jl Outdated Show resolved Hide resolved
examples/mindistortion.jl Outdated

It is known that the 4-point metric space defined by the star graph:
x
\\
Copy link
Member

Choose a reason for hiding this comment

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

Extra "\"

Copy link
Member Author

Choose a reason for hiding this comment

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

Because it is in the docstring it needed to escape the \.

examples/minellipse.jl Outdated Show resolved Hide resolved
examples/minellipse.jl Outdated Show resolved Hide resolved
examples/run_examples.jl Outdated Show resolved Hide resolved
examples/urbanplan.jl Outdated Show resolved Hide resolved
@chriscoey
Copy link
Contributor

Perhaps for a separate PR: can I suggest a renaming of some examples to further improve consistency (eg underscores) and understandability. I think we can be verbose with names here.

Eg steelT3 - no idea what the T3 means, off the bat

@hochB
Copy link

hochB commented Dec 30, 2018

I want to say that for newcomers examples are more helpful than anything else.
So a big thank you for working on this.

hochB
hochB reviewed Dec 30, 2018
View reviewed changes
examples/sudoku.jl Outdated Show resolved Hide resolved
@odow
Copy link
Member Author

odow commented Dec 30, 2018

Perhaps for a separate PR: can I suggest a renaming of some examples to further improve consistency (eg underscores) and understandability. I think we can be verbose with names here.

Totally agree. I'm almost verging on these examples should be included in the documentation and structured as tutorial/notebooky type things. But let's get them tidied up and passing tests first.

@odow
Copy link
Member Author

odow commented Dec 30, 2018

Okay, all the examples have been updated to the latest JuMP master and are tested in a separate build stage on travis.

While I have tidied up many of the examples for style and more JuMPish conventions (see diet.jl whic uses DenseAxisArray to the data :)), I didn't fix all of them (e.g. prod.jl).

Once this PR is in, I might move a few of the examples into the docs with doctests. Maybe one MIP, one NLP, and one conic.

@blegat
Copy link
Member

blegat commented Dec 31, 2018

Once this PR is in, I might move a few of the examples into the docs with doctests. Maybe one MIP, one NLP, and one conic.

With MockOptimizer ? So that the doctests keep their independence with solvers.

mlubin
mlubin reviewed Jan 1, 2019
View reviewed changes
examples/run_examples.jl Outdated Show resolved Hide resolved
examples/sudoku.jl Outdated Show resolved Hide resolved
mlubin
mlubin approved these changes Jan 1, 2019
View reviewed changes
examples/basic.jl
@@ -4,7 +4,7 @@
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#############################################################################
# JuMP
# An algebraic modeling langauge for Julia
# An algebraic modeling language for Julia
Copy link
Member

Choose a reason for hiding this comment

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

I can't believe this typo was still here.

Copy link
Member Author

Choose a reason for hiding this comment

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

See #1720

@odow odow mentioned this pull request Jan 1, 2019
Merged
@odow odow merged commit 9483613 into master Jan 2, 2019
@odow odow deleted the od/test_examples branch January 2, 2019 00:52
@barpit20 barpit20 mentioned this pull request Mar 15, 2019
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hochB hochB hochB left review comments

@mlubin mlubin mlubin approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@odow @chriscoey @hochB @blegat @mlubin