Skip to content

Commit 77e48f9

Browse files
committed
Algorithmic benchmark - no abbrev
Change-Id: Ic95e07f4690f4f10bf2634eda7a66ac81649774a
1 parent a8c0cf7 commit 77e48f9

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

recirq/algo_benchmark_library.py renamed to recirq/algorithmic_benchmark_library.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,27 @@
99

1010

1111
@dataclass
12-
class AlgoBenchmark:
12+
class AlgorithmicBenchmark:
1313
domain: str
1414
"""The problem domain. Usually a high-level ReCirq module."""
1515

1616
name: str
1717
"""The benchmark name. Must be unique within the domain."""
1818

1919
executable_family: str
20-
"""A globally unique identifier for this AlgoBenchmark.
20+
"""A globally unique identifier for this AlgorithmicBenchmark.
2121
2222
This should match up with this Benchmark's `spec_class.executable_family`.
2323
2424
By convention, the executable family is the fully-qualified leaf-module where the code
25-
for this AlgoBenchmark lives.
25+
for this AlgorithmicBenchmark lives.
2626
"""
2727

2828
spec_class: Type[ExecutableSpec]
29-
"""The ExecutableSpec subclass for this AlgoBenchmark."""
29+
"""The ExecutableSpec subclass for this AlgorithmicBenchmark."""
3030

3131
data_class: Type
32-
"""The class which can contain ETL-ed data for this AlgoBenchmark."""
32+
"""The class which can contain ETL-ed data for this AlgorithmicBenchmark."""
3333

3434
gen_func: Callable[[...], QuantumExecutableGroup]
3535
"""The function that returns a QuantumExecutableGroup for a given Config."""
@@ -47,7 +47,7 @@ def as_strings(self):
4747
@dataclass
4848
class BenchmarkConfig:
4949
short_name: str
50-
"""The short name for this config. Unique within an AlgoBenchmark."""
50+
"""The short name for this config. Unique within an AlgorithmicBenchmark."""
5151

5252
full_name: str
5353
"""A globally unique name for this config."""
@@ -64,7 +64,7 @@ class BenchmarkConfig:
6464

6565

6666
@lru_cache()
67-
def get_all_algo_configs() -> List[Tuple[AlgoBenchmark, BenchmarkConfig]]:
67+
def get_all_algo_configs() -> List[Tuple[AlgorithmicBenchmark, BenchmarkConfig]]:
6868
ret = []
6969
for algo in BENCHMARKS:
7070
for config in algo.configs:

recirq/algo_benchmark_library_test.py renamed to recirq/algorithmic_benchmark_library_test.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
import pytest
66

7-
from recirq.algo_benchmark_library import BENCHMARKS, get_all_algo_configs
7+
from recirq.algorithmic_benchmark_library import BENCHMARKS, get_all_algo_configs
88

99
RECIRQ_DIR = os.path.abspath(os.path.dirname(__file__) + '/../')
1010

@@ -25,7 +25,7 @@ def test_benchmark_name_unique_in_domain():
2525

2626
@pytest.mark.parametrize('algo', BENCHMARKS)
2727
def test_executable_family_is_formulaic(algo):
28-
# Check consistency in the AlgoBenchmark dataclass:
28+
# Check consistency in the AlgorithmicBenchmark dataclass:
2929
assert algo.executable_family == algo.spec_class.executable_family
3030

3131
# By convention, we set this to be the module name. By further convention,

0 commit comments

Comments
 (0)