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

DOC: update benchmarking docs to use dev.py user interface #16633

Merged
merged 5 commits into from Sep 4, 2022
Merged

DOC: update benchmarking docs to use dev.py user interface #16633

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6facad8
Updating benchmarking.rst documentation
hfactor13 Jul 17, 2022
e309864
DOC: Updating benchmarking.rst documentation
hfactor13 Jul 17, 2022
20dcfeb
Merge branch 'my-dev-branch' of https://github.com/hfactor13/scipy in…
hfactor13 Jul 17, 2022
5e93329
DOC: Ran benchmarks and fixed a typo
hfactor13 Sep 3, 2022
761ef62
BENCH: fix `dev.py bench --compare`
rgommers Sep 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/source/dev/contributor/benchmarking.rst
View file
Open in desktop
Expand Up @@ -92,7 +92,7 @@ submitting a pull request.
To run all benchmarks, navigate to the root SciPy directory at the
command line and execute::

python runtests.py --bench
python dev.py --bench

where ``--bench`` activates the benchmark suite instead of the test
suite. This builds SciPy and runs the benchmarks. (*Note: this could
Expand All @@ -104,17 +104,17 @@ To run benchmarks from a particular benchmark module, such as
``optimize_linprog.py``, simply append the filename without the
extension::

python runtests.py --bench optimize_linprog
python dev.py --bench optimize_linprog

To run a benchmark defined in a class, such as ``KleeMinty`` from
``optimize_linprog.py``::

python runtests.py --bench optimize_linprog.KleeMinty
python dev.py --bench optimize_linprog.KleeMinty
rgommers marked this conversation as resolved.
Show resolved Hide resolved

To compare benchmark results between the active branch and another, such
as ``main``::

python runtests.py --bench-compare main optimize_linprog.KleeMinty
python dev.py --bench-compare main optimize_linprog.KleeMinty
rgommers marked this conversation as resolved.
Show resolved Hide resolved

All of the commands above display the results in plain text in the
console, and the results are not saved for comparison with future
Expand Down