SolverBenchmark

Benchmark tools for solvers

https://github.com/juliasmoothoptimizers/solverbenchmark.jl

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary

Keywords from Contributors

nlpmodels nonlinear-programming hsl sparse-matrix factorization ipopt nonlinear-optimization mps qps optimization-algorithms
Last synced: 6 months ago · JSON representation ·

Repository

Benchmark tools for solvers

Basic Info
  • Host: GitHub
  • Owner: JuliaSmoothOptimizers
  • License: other
  • Language: Julia
  • Default Branch: main
  • Size: 3.87 MB
Statistics
  • Stars: 22
  • Watchers: 4
  • Forks: 12
  • Open Issues: 16
  • Releases: 22
Created about 7 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation Zenodo

README.md

SolverBenchmark.jl

How to Cite

If you use SolverBenchmark.jl in your work, please cite using the format given in CITATION.cff.

DOI CI Build Status codecov

This package provides general tools for benchmarking solvers, focusing on the following guidelines: - The output of a solver's run on a suite of problems is a DataFrame, where each row is a different problem. - Since naming issues may arise (e.g., same problem with different number of variables), there must be an ID column; - The collection of two or more solver runs (DataFrames), is a Dict{Symbol,DataFrame}, where each key is a solver;

This package is developed focusing on Krylov.jl and JSOSolvers.jl, but is sufficiently general to be used in other places.

Example

Obs: See the assets folder for the complete code, or the docs for a more detailed example.

Example table of a single DataFrame

pretty_stats(df)

┌─────────────┬─────────┬───────────┬───────────┬────────┐ │ flag │ name │ f(x) │ time │ iter │ ├─────────────┼─────────┼───────────┼───────────┼────────┤ │ failure │ prob001 │ -6.89e-01 │ 6.24e+01 │ 70 │ │ failure │ prob002 │ -7.63e-01 │ 3.53e+02 │ 10 │ │ first_order │ prob003 │ 3.97e-01 │ 7.68e+02 │ 10 │ │ first_order │ prob004 │ 8.12e-01 │ 4.31e+01 │ 80 │ │ first_order │ prob005 │ -3.46e-01 │ 2.68e+02 │ 30 │ │ first_order │ prob006 │ -1.88e-01 │ 6.68e+01 │ 80 │ │ first_order │ prob007 │ -1.61e+00 │ 1.57e+02 │ 60 │ │ first_order │ prob008 │ -2.48e+00 │ 6.05e+02 │ 40 │ │ first_order │ prob009 │ 2.28e+00 │ 1.36e+02 │ 40 │ │ failure │ prob010 │ 2.20e-01 │ 8.38e+02 │ 50 │ └─────────────┴─────────┴───────────┴───────────┴────────┘

pretty_latex_stats(df)

Example table of a joined DataFrame

df = join(stats, [:status, :f, :t], ...) pretty_stats(df, tf=markdown)

| id | name | flag_alpha | f_alpha | t_alpha | flag_beta | f_beta | t_beta | flag_gamma | f_gamma | t_gamma | |--------|---------|-------------|-----------|-----------|-------------|-----------|-----------|-------------|-----------|-----------| | 1 | prob001 | failure | -6.89e-01 | 6.24e+01 | first_order | -4.83e-01 | 3.92e+02 | failure | -9.99e-01 | 6.97e+02 | | 2 | prob002 | failure | -7.63e-01 | 3.53e+02 | first_order | -1.16e+00 | 4.79e+02 | first_order | 1.03e+00 | 4.35e+02 | | 3 | prob003 | first_order | 3.97e-01 | 7.68e+02 | first_order | -2.14e-01 | 6.82e+01 | first_order | -1.16e+00 | 9.86e+02 | | 4 | prob004 | first_order | 8.12e-01 | 4.31e+01 | first_order | -1.37e+00 | 4.80e+02 | first_order | 5.34e-01 | 9.97e+02 | | 5 | prob005 | first_order | -3.46e-01 | 2.68e+02 | first_order | -1.54e+00 | 4.68e+02 | first_order | -3.08e-01 | 5.08e+02 | | 6 | prob006 | first_order | -1.88e-01 | 6.68e+01 | first_order | -1.23e+00 | 4.52e+02 | first_order | 9.86e-01 | 2.16e+02 | | 7 | prob007 | first_order | -1.61e+00 | 1.57e+02 | first_order | -1.96e+00 | 6.44e+02 | first_order | -1.19e+00 | 8.59e+02 | | 8 | prob008 | first_order | -2.48e+00 | 6.05e+02 | failure | -4.73e-01 | 6.69e+02 | first_order | 6.80e-01 | 9.05e+02 | | 9 | prob009 | first_order | 2.28e+00 | 1.36e+02 | first_order | 1.34e+00 | 9.48e+01 | failure | 2.04e-03 | 4.35e+02 | | 10 | prob010 | failure | 2.20e-01 | 8.38e+02 | first_order | 8.08e-01 | 9.49e+02 | first_order | -4.78e-01 | 6.59e+01 |

pretty_latex_stats(df)

Example profile

p = performance_profile(stats, df->df.t)

Example profile-wall

p = profile_solvers(stats, costs, titles)

Bug reports and discussions

If you think you found a bug, feel free to open an issue. Focused suggestions and requests can also be opened as issues. Before opening a pull request, start an issue or a discussion on the topic, please.

If you want to ask a question not suited for a bug report, feel free to start a discussion here. This forum is for general discussion about this repository and the JuliaSmoothOptimizers organization, so questions about any of our packages are welcome.

Owner

  • Name: JuliaSmoothOptimizers
  • Login: JuliaSmoothOptimizers
  • Kind: organization
  • Location: DOI: 10.5281/zenodo.2655082

Infrastructure and Solvers for Continuous Optimization in Julia

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
  SolverBenchmark.jl: Benchmark Tools for Solvers
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Dominique
    family-names: Orban
    email: dominique.orban@gerad.ca
    orcid: 'https://orcid.org/0000-0002-8017-7687'
    affiliation: >-
      GERAD and Department of Mathematics and
      Industrial Engineering, Polytechnique Montréal,
      QC, Canada
  - affiliation: 'Netherlands eScience Center, Amsterdam, NL'
    orcid: 'https://orcid.org/0000-0003-4451-281X'
    email: abel.s.siqueira@gmail.com
    given-names: Abel
    family-names: Soares Siqueira
  - given-names: contributors
identifiers:
  - description: Zenodo archive
    type: doi
    value: 10.5281/zenodo.4154524
keywords:
  - Nonlinear Optimization
  - Benchmark
  - Julia
  - Nonlinear Programming
license: MPL-2.0
version: 0.6.0
date-released: '2023-11-21'
repository-code: >-
  https://github.com/JuliaSmoothOptimizers/SolverBenchmark.jl

GitHub Events

Total
  • Create event: 15
  • Commit comment event: 1
  • Release event: 1
  • Issues event: 4
  • Delete event: 14
  • Issue comment event: 33
  • Push event: 54
  • Pull request review comment event: 22
  • Pull request review event: 18
  • Pull request event: 35
  • Fork event: 2
Last Year
  • Create event: 15
  • Commit comment event: 1
  • Release event: 1
  • Issues event: 4
  • Delete event: 14
  • Issue comment event: 33
  • Push event: 54
  • Pull request review comment event: 22
  • Pull request review event: 18
  • Pull request event: 35
  • Fork event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 157
  • Total Committers: 14
  • Avg Commits per committer: 11.214
  • Development Distribution Score (DDS): 0.669
Top Committers
Name Email Commits
Dominique Orban d****n@g****m 52
Abel Soares Siqueira a****a@g****m 38
tmigot t****t@g****m 30
Alexis Montoison a****n@p****a 10
github-actions[bot] 4****]@u****m 8
Geoffroy Leconte g****0@g****m 5
geoffroyleconte 4****e@u****m 4
farhadrclass 3****s@u****m 4
AntoninKns a****s@e****r 1
AntoninKns 4****s@u****m 1
Julia TagBot 5****t@u****m 1
Monssaf Toukal t****f@g****m 1
Abel Siqueira n****1@g****m 1
dpo d****o@u****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 19
  • Total pull requests: 137
  • Average time to close issues: 10 days
  • Average time to close pull requests: 12 days
  • Total issue authors: 9
  • Total pull request authors: 14
  • Average comments per issue: 3.32
  • Average comments per pull request: 1.77
  • Merged pull requests: 114
  • Bot issues: 0
  • Bot pull requests: 23
Past Year
  • Issues: 3
  • Pull requests: 30
  • Average time to close issues: 11 days
  • Average time to close pull requests: 8 days
  • Issue authors: 3
  • Pull request authors: 6
  • Average comments per issue: 2.0
  • Average comments per pull request: 1.93
  • Merged pull requests: 23
  • Bot issues: 0
  • Bot pull requests: 6
Top Authors
Issue Authors
  • tmigot (5)
  • abelsiqueira (3)
  • MaxenceGollier (2)
  • amontoison (2)
  • d-monnet (2)
  • dpo (2)
  • DoctorDro (2)
  • geoffroyleconte (1)
  • JuliaTagBot (1)
Pull Request Authors
  • dpo (50)
  • tmigot (40)
  • github-actions[bot] (26)
  • geoffroyleconte (7)
  • amontoison (7)
  • abelsiqueira (7)
  • farhadrclass (6)
  • JSOBot (2)
  • DoctorDro (2)
  • MaxenceGollier (1)
  • d-monnet (1)
  • paraynaud (1)
  • MonssafToukal (1)
  • AntoninKns (1)
Top Labels
Issue Labels
bug (5) enhancement (4) good first issue (2) question (1) documentation (1)
Pull Request Labels
formatting (15) automated pr (15) no changelog (15) documentation (6) bug (3) CI (3) :stop_sign: do not merge (2) help wanted (1) enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 9 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 22
juliahub.com: SolverBenchmark

Benchmark tools for solvers

  • Versions: 22
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 9 Total
Rankings
Dependent repos count: 9.9%
Forks count: 17.4%
Average: 22.3%
Stargazers count: 22.7%
Dependent packages count: 38.9%
Last synced: 7 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
  • julia-actions/setup-julia latest composite
.github/workflows/Documentation.yml actions
  • actions/checkout v2 composite
  • julia-actions/setup-julia latest composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/ci.yml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • codecov/codecov-action v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/format_pr.yml actions
  • actions/checkout v2 composite
  • peter-evans/create-pull-request v3 composite
.github/workflows/Breakage.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/setup-julia v2 composite
  • thollander/actions-comment-pull-request v2 composite
.github/workflows/examples.yml actions
  • actions/cache v4 composite
  • actions/checkout v2 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/setup-julia v2 composite