soev for developers
soev-evalsReference

Commands

Run, report, rescore and seal evaluation projects.

soev-evals

soev-evals [-h] [--debug] {run,report,rescore,seal} ...
ArgumentDefaultDescription
--debugShow a traceback (sealed content remains redacted)

Installed packages can add commands through the entry-point group soev.evals.commands.

soev-evals run

Run the cases and keep their evidence

soev-evals run [-h] --project PROJECT [--runs-dir RUNS_DIR] [--suite SUITE]
                      [--split {dev,test}] [--k K] [--resume RUN_ID] [--run-id RUN_ID]
                      [--runtime RUNTIME]
ArgumentDefaultDescription
--projectrequiredPath to project.yaml
--runs-dirThe directory of the run archives. The default is runs/ beside project.yaml.
--suiteThe name of a suite. Repeat it to select more suites.
--splitOnly the cases of this split. One of dev, test.
--kThe number of attempts of each case. It replaces runs.k of project.yaml.
--resumeContinue the archived run RUN_ID
--run-idOptional name for a new run
--runtimeThe name of a runtime provider in the entry-point group soev.evals.runtimes. Without it and without runtime: in project.yaml, the run has no judge, and each judge criterion gives an error verdict.

soev-evals report

Print the archived report

soev-evals report [-h] --project PROJECT [--runs-dir RUNS_DIR] RUN
ArgumentDefaultDescription
--projectrequiredPath to project.yaml
--runs-dirThe directory of the run archives. The default is runs/ beside project.yaml.
RUNrequiredThe id of the archived run

soev-evals rescore

Score the archived evidence again

soev-evals rescore [-h] --project PROJECT [--runs-dir RUNS_DIR] [--offline]
                          [--runtime RUNTIME]
                          RUN
ArgumentDefaultDescription
--projectrequiredPath to project.yaml
--runs-dirThe directory of the run archives. The default is runs/ beside project.yaml.
RUNrequiredThe id of the archived run
--offlineKeep archived judge verdicts
--runtimeThe name of a runtime provider in the entry-point group soev.evals.runtimes. Without it and without runtime: in project.yaml, the rescore has no judge, and each judge criterion gives an error verdict.

soev-evals seal

Record a digest of each test case, so that a later change to a sealed test case stops each command

soev-evals seal [-h] --project PROJECT [--append]
ArgumentDefaultDescription
--projectrequiredPath to project.yaml
--appendAccept new test cases. Each sealed test case must stay the same.

On this page