Skip to content

Commit 5f8b0ff

Browse files
committed
doc: detaile docstring for prover_evaluate
1 parent fb99ad6 commit 5f8b0ff

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

src/tfbench/evaluation.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,16 @@ def prover_evaluate(
130130
"""evaluate all generation results using GHC to prove equivalence
131131
132132
NOTE: currently only support the `base` split
133+
134+
Args:
135+
tasks (list[BenchmarkTask]): list of benchmark tasks
136+
results (list[LMAnswer | None]): list of generation results
137+
pure (bool, optional): whether to evaluate on the `pure` split or not.
138+
Since we use TypeOperators to *prove type equivalence,
139+
we need to define all custom types in the `pure` split.
140+
Defaults to False.
141+
nproc (int, optional): number of processes to use.
142+
Defaults to cpu_count() to use all available CPUs.
133143
"""
134144
assert len(tasks) == len(results)
135145

0 commit comments

Comments
 (0)