Skip to content

Commit 2699bd3

Browse files
committed
add docstring
1 parent 7ec5154 commit 2699bd3

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

src/vivarium_profiling/tools/run_benchmark.py

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,26 @@ def run_benchmark_loop(
250250
output_dir: str = ".",
251251
verbose: int = 0,
252252
) -> str:
253-
"""Main function to run benchmarks on model specifications."""
253+
"""Main function to run benchmarks on model specifications.
254+
255+
Parameters
256+
----------
257+
model_specs
258+
List of model specification file paths.
259+
model_runs
260+
Number of runs for non-baseline models.
261+
baseline_model_runs
262+
Number of runs for the baseline model.
263+
output_dir
264+
Directory to save results.
265+
verbose
266+
Verbosity level for logging.
267+
268+
Returns
269+
-------
270+
Path to the results directory.
271+
272+
"""
254273
configure_logging_to_terminal(verbose)
255274

256275
# Validate inputs

0 commit comments

Comments
 (0)