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

Benchmark #46

Merged
merged 6 commits into from
Jun 10, 2019
Merged

Conversation

aa25desh
Copy link
Contributor

@aa25desh aa25desh commented Jun 7, 2019

No description provided.

@mforets
Copy link
Contributor

mforets commented Jun 7, 2019

This PR adds some arithmetic benchmarks from AGK18.

We plan to make a second PR to reproduce Tables 3-6 in the same paper that uses some of the tests defined in Project Daisy.

@lbenet
Copy link
Member

lbenet commented Jun 7, 2019

@aadesha Thanks for your contribution. Is this ready for review?

@aa25desh
Copy link
Contributor Author

aa25desh commented Jun 7, 2019 via email

@mforets
Copy link
Contributor

mforets commented Jun 7, 2019

It's ready, we are going to add another set of benchmarks too. Probably
tomorrow.

In a separate PR. This one is ready for review.

Copy link
Member

@lbenet lbenet left a comment

Choose a reason for hiding this comment

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

In general, it looks good to me. I have few general comments though:

  • I think it is to have a Benchmark/README.md file, with some general info about the benchmarks (e.g., how to run them), and perhaps also give a summary of the results or pointers to some pages where the actual results are. This should be easy

  • Rename Benchmarks directory to Benchmarks (note the final "s"), and perhaps use lower case. Maybe @dpsanders has something to say as a native speaker...

  • Add separately the scalar cases as well.

  • It is also a good idea to have an automatic way to create and display the (bechmark) results. I am thinking of using Weave.jl or Literate.jl. (Perhaps it is too much to ask for this PR, but well-worth the effort for maintenance.

@lbenet
Copy link
Member

lbenet commented Jun 7, 2019

For the last point of my comment, see SciML/SciMLBenchmarks.jl#32

@mforets
Copy link
Contributor

mforets commented Jun 7, 2019

I think it is to have a Benchmark/README.md file,

+1 This file has the basic commands to run and display results; @aadesha could you collect them in benchmark/README.md?

Rename Benchmarks directory to Benchmarks (note the final "s"), and perhaps use lower case. Maybe @dpsanders has something to say as a native speaker...

The filename and folder are the ones adopted by convention in PkgBenchmarks, however it should be benchmark (@aadesha mind the lower case), see this doc.

Add separately the scalar cases as well.

+1 IIUC, you'd like to have (in addition to the ones added here) @benchmarkable $b1 + $b2 and so on.

It is also a good idea to have an automatic way to create and display the (bechmark) results. I am thinking of using Weave.jl or Literate.jl. (Perhaps it is too much to ask for this PR, but well-worth the effort for maintenance.

That would be awesome; export_markdown("results.md", results) works but one has to manually plug that output into a document.

@mforets
Copy link
Contributor

mforets commented Jun 7, 2019

Perhaps it is too much to ask for this PR

Yes, better leave that for later..

@aa25desh
Copy link
Contributor Author

aa25desh commented Jun 7, 2019 via email

@lbenet
Copy link
Member

lbenet commented Jun 7, 2019

The plan LGTM: address the first three points, and open an issue with the fourth one, so we don't forget about it.

@aa25desh
Copy link
Contributor Author

aa25desh commented Jun 7, 2019 via email

Benchmark/arithmetic.jl Outdated Show resolved Hide resolved
@aa25desh
Copy link
Contributor Author

aa25desh commented Jun 9, 2019

PR is ready for review.

Copy link
Member

@lbenet lbenet left a comment

Choose a reason for hiding this comment

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

I have pointed out to a typo in the README.md guide.

Aside form this, I think the directory name should be benchmark instead of Benchmark; in my Mac this causes no problem, but it may if you on a linux box (I haven't checked it). I have no way to test this, but I could do it later.

Benchmark/README.md Outdated Show resolved Hide resolved
@lbenet
Copy link
Member

lbenet commented Jun 10, 2019

Thanks a lot! I'm merging

@lbenet lbenet merged commit 4399b9b into JuliaIntervals:master Jun 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants