Skip to content

Commit a145431

Browse files
committed
make sure it is clear that score is 0.0-1.0 inclusive
1 parent 5649fea commit a145431

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

src/runloop_api_client/sdk/async_scenario_builder.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ def add_bash_script_scorer(
213213
) -> Self:
214214
"""Add a bash script scorer.
215215
216-
The script should output "score=X.X" where X.X is a float between 0.0 and 1.0.
216+
The script should output "score=X.X" where X.X is a float between 0.0 and 1.0, inclusive.
217217
218218
:param name: Name of the scoring function
219219
:type name: str
@@ -241,7 +241,7 @@ def add_python_script_scorer(
241241
) -> Self:
242242
"""Add a Python script scorer.
243243
244-
The script should print the score (0.0-1.0) to stdout.
244+
The script should print the score in the range [0.0, 1.0] to stdout.
245245
246246
:param name: Name of the scoring function
247247
:type name: str

src/runloop_api_client/sdk/async_scorer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
class AsyncScorer:
1717
"""A custom scorer for evaluating scenario outputs (async).
1818
19-
Scorers define bash scripts that produce a score (0.0-1.0) for scenario runs.
19+
Scorers define bash scripts that produce a score in the range [0.0, 1.0] for scenario runs.
2020
Obtain instances via ``runloop.scorer.create()`` or ``runloop.scorer.from_id()``.
2121
2222
Example:

src/runloop_api_client/sdk/scenario_builder.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ def add_bash_script_scorer(
213213
) -> Self:
214214
"""Add a bash script scorer.
215215
216-
The script should output "score=X.X" where X.X is a float between 0.0 and 1.0.
216+
The script should output "score=X.X" where X.X is a float between 0.0 and 1.0, inclusive.
217217
218218
:param name: Name of the scoring function
219219
:type name: str
@@ -241,7 +241,7 @@ def add_python_script_scorer(
241241
) -> Self:
242242
"""Add a Python script scorer.
243243
244-
The script should print the score (0.0-1.0) to stdout.
244+
The script should print the score in the range [0.0, 1.0] to stdout.
245245
246246
:param name: Name of the scoring function
247247
:type name: str

src/runloop_api_client/sdk/scorer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
class Scorer:
1717
"""A custom scorer for evaluating scenario outputs.
1818
19-
Scorers define bash scripts that produce a score (0.0-1.0) for scenario runs.
19+
Scorers define bash scripts that produce a score in the range [0.0, 1.0] for scenario runs.
2020
Obtain instances via ``runloop.scorer.create()`` or ``runloop.scorer.from_id()``.
2121
2222
Example:

0 commit comments

Comments
 (0)