Skip to content

Commit ee0faf3

Browse files
committed
Use dashes in benchmark script filenames
Rename the benchmark scripts to match the dashed naming of the other dev scripts (e.g. make-release-notes.py): benchmark_grounding.py -> benchmark-grounding.py benchmark_search.py -> benchmark-search.py compare_benchmarks.py -> compare-benchmarks.py and update the cross-references in their docstrings.
1 parent 319ae73 commit ee0faf3

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
Each task is grounded in a separate subprocess so that a per-task timeout can
55
be enforced (grounding a large task can take a long time or a lot of memory).
66
The results are written as JSON so that two revisions can be compared with
7-
``compare_benchmarks.py``.
7+
``compare-benchmarks.py``.
88
99
The ``--src`` option selects which pyperplan source tree to benchmark; it is put
1010
on ``PYTHONPATH`` for the worker subprocesses, so the script itself can live
1111
outside the revision under test.
1212
1313
Examples:
14-
dev/benchmark_grounding.py --out grounding-new.json
15-
dev/benchmark_grounding.py --src /tmp/pyperplan-base --out grounding-base.json
14+
dev/benchmark-grounding.py --out grounding-new.json
15+
dev/benchmark-grounding.py --src /tmp/pyperplan-base --out grounding-base.json
1616
"""
1717

1818
import argparse
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
For each configuration and task, ``python -m pyperplan`` is invoked as a
55
subprocess with a per-run timeout, and the planner's reported "Overall time" is
66
recorded. The results are written as JSON so that two revisions can be compared
7-
with ``compare_benchmarks.py``.
7+
with ``compare-benchmarks.py``.
88
99
The configurations below cover every search algorithm and every heuristic at
1010
least once. By default the first task of each benchmark domain is used; pass
@@ -14,8 +14,8 @@
1414
on ``PYTHONPATH`` for the subprocesses.
1515
1616
Examples:
17-
dev/benchmark_search.py --out search-new.json
18-
dev/benchmark_search.py --src /tmp/pyperplan-base --out search-base.json
17+
dev/benchmark-search.py --out search-new.json
18+
dev/benchmark-search.py --src /tmp/pyperplan-base --out search-base.json
1919
"""
2020

2121
import argparse
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
#! /usr/bin/env python3
22
"""Compare two benchmark result files and plot relative runtimes.
33
4-
Reads two JSON files produced by ``benchmark_grounding.py`` or
5-
``benchmark_search.py`` (an "old" and a "new" revision) and, for the tasks that
4+
Reads two JSON files produced by ``benchmark-grounding.py`` or
5+
``benchmark-search.py`` (an "old" and a "new" revision) and, for the tasks that
66
both revisions completed successfully, prints a runtime summary and writes a
77
log-log scatter plot of old vs. new runtime. Points below the diagonal were
88
faster on the new revision.
99
1010
Examples:
11-
dev/compare_benchmarks.py grounding-base.json grounding-new.json \
11+
dev/compare-benchmarks.py grounding-base.json grounding-new.json \
1212
--out grounding.png --title "Grounding time"
13-
dev/compare_benchmarks.py search-base.json search-new.json \
13+
dev/compare-benchmarks.py search-base.json search-new.json \
1414
--out search.png --title "Search time" --success solved
1515
"""
1616

0 commit comments

Comments
 (0)