Skip to content

Commit bfd929e

Browse files
committed
refactor(eval): rename register decorator to register_eval decorator for clarity
1 parent 8c09dc9 commit bfd929e

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The package lives in `src/strands_env/` with these modules:
7171

7272
**evaluator.py**`Evaluator` class orchestrates concurrent rollouts with checkpointing and pass@k metrics. Takes an async `env_factory` for flexible environment creation. Uses tqdm with `logging_redirect_tqdm` for clean progress output. Subclasses implement `load_dataset()` for different benchmarks.
7373

74-
**registry.py** — Benchmark registry with `@register(name)` decorator. `get_benchmark(name)` and `list_benchmarks()` for discovery.
74+
**registry.py** — Benchmark registry with `@register_eval(name)` decorator. `get_benchmark(name)` and `list_benchmarks()` for discovery.
7575

7676
**metrics.py**`compute_pass_at_k` implements the unbiased pass@k estimator. `MetricFn` type alias for pluggable metrics.
7777

docs/evaluation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ def create_env_factory(model_factory: ModelFactory, env_config: EnvConfig):
150150

151151
## Custom Evaluators
152152

153-
For custom benchmarks, subclass `Evaluator`. You can either register it with `@register` or use an evaluator hook file.
153+
For custom benchmarks, subclass `Evaluator`. You can either register it with `@register_eval` or use an evaluator hook file.
154154

155155
### Evaluator Hook File
156156

@@ -186,15 +186,15 @@ strands-env eval --evaluator my_evaluator.py --env my_env.py --backend sglang
186186

187187
### Registered Evaluator
188188

189-
Alternatively, use `@register` to make it available by name:
189+
Alternatively, use `@register_eval` to make it available by name:
190190

191191
```python
192192
from collections.abc import Iterable
193193

194194
from strands_env.core import Action, TaskContext
195-
from strands_env.eval import Evaluator, register
195+
from strands_env.eval import Evaluator, register_eval
196196

197-
@register("my-benchmark")
197+
@register_eval("my-benchmark")
198198
class MyEvaluator(Evaluator):
199199
benchmark_name = "my-benchmark"
200200

src/strands_env/eval/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
from .aime import AIME2024Evaluator, AIME2025Evaluator, AIMEEvaluator
1616
from .evaluator import AsyncEnvFactory, EvalSample, Evaluator
1717
from .metrics import MetricFn, compute_pass_at_k
18-
from .registry import get_benchmark, list_benchmarks, register
18+
from .registry import get_benchmark, list_benchmarks, register_eval
1919

2020
__all__ = [
2121
"AIME2024Evaluator",
@@ -28,5 +28,5 @@
2828
"get_benchmark",
2929
"list_benchmarks",
3030
"compute_pass_at_k",
31-
"register",
31+
"register_eval",
3232
]

src/strands_env/eval/aime.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
from strands_env.core import Action, TaskContext
2626

2727
from .evaluator import Evaluator
28-
from .registry import register
28+
from .registry import register_eval
2929

3030
logger = logging.getLogger(__name__)
3131

@@ -59,15 +59,15 @@ def load_dataset(self) -> Iterable[Action]:
5959
)
6060

6161

62-
@register("aime-2024")
62+
@register_eval("aime-2024")
6363
class AIME2024Evaluator(AIMEEvaluator):
6464
"""AIME 2024 benchmark."""
6565

6666
benchmark_name = "aime-2024"
6767
dataset_path = "HuggingFaceH4/aime_2024"
6868

6969

70-
@register("aime-2025")
70+
@register_eval("aime-2025")
7171
class AIME2025Evaluator(AIMEEvaluator):
7272
"""AIME 2025 benchmark."""
7373

src/strands_env/eval/registry.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525
_BENCHMARKS: dict[str, type[Evaluator]] = {}
2626

2727

28-
def register(name: str):
28+
def register_eval(name: str):
2929
"""Decorator to register a benchmark evaluator.
3030
3131
Example:
32-
@register("aime")
32+
@register_eval("aime")
3333
class AIMEEvaluator(Evaluator):
3434
...
3535
"""

tests/unit/test_registry.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from strands_env.cli import cli
77
from strands_env.eval import Evaluator, get_benchmark, list_benchmarks
88
from strands_env.eval.registry import _BENCHMARKS
9-
from strands_env.eval.registry import register as register_benchmark
9+
from strands_env.eval.registry import register_eval as register_benchmark
1010

1111

1212
class TestBenchmarkRegistry:

0 commit comments

Comments
 (0)