Essai · Référence

Référence

The exact interfaces of Essai: functions, the task-file format and the reports it writes.

À venir This page is an outline. Each section below keeps its coming soon stamp until it describes code that exists in the repository.

Available now

The package currently exposes its version, fonderie_essai.__version__, and nothing else.

Planned sections

  1. Python API

    Coming soon

    Public modules, functions and classes of fonderie_essai, generated from their docstrings once the interfaces settle.

  2. Task-file format

    Coming soon

    Every field of a task file and the rules its validator enforces.

  3. Run-record schema

    Coming soon

    The run record field by field, shared in form with Affinage.

  4. Per-item outputs

    Coming soon

    The format of the outputs and scores written for each evaluation item.

  5. Comparison report

    Coming soon

    How differences between models, revisions and edits are reported, with their intervals.