Reference

Reference

Use Reference when you already know what you are trying to do and need the exact contract, command, term, provenance rule, or authoritative record. If you need a sequence of actions instead, use the Guides; if you want to learn by doing, use the Examples. If you are unsure which kind of documentation you need, start with the Documentation compass.

Choose by question

Find the right reference faster

If you know the topic but are unsure whether you need a Guide, Example, Reference, or Evidence page, use Find information fast. The Search → contract walkthrough shows the grouped-search route on fully synthetic questions.

Copy-ready common routes

These compact routes are factual navigation aids. The site automatically adds a Copy control to code blocks; copying a route does not make its scientific choices appropriate for a study.

GazeStudy → audit_study_qc → study_qc_diagnostics → build_study_qc_audit

PipelineSpace → run_specs → specification_curve → effect_stability

GaussianGazeErrorModel → aoi_probabilities → compare_hard_probabilistic → expected_dwell

gazeaudit-revision-package validate --root revision-package

Use the API map or CLI reference to verify the exact contract behind a copied route.

Public API

The API map is the practical entry point. It groups the public surface by canonical study representation, structural QC, readiness governance, AOI uncertainty, specification spaces, controlled sensitivity, publication provenance, plotting, BIDS, pymovements, pEYES, and validation-specific tooling.

The API pathways page is the contextual entry point when you already know a symbol. It gives that symbol a stable deep link and connects its governed method family to the corresponding guide, runnable example, visual, and evidence boundary. When JavaScript is available, the same page adds CI-verified source metadata: inspected signatures, modules, source lines, summaries, imports, and pathway backlinks. Use Read the source-level API reference for the interpretation rules.

The core API inventory is intentionally denser. Use it when you already know the symbol family and need a compact lookup rather than workflow guidance.

Command line

The CLI reference is generated conceptually from the console scripts declared in pyproject.toml. It separates the general reviewer-revision package command from the specialised source-intake/freeze commands used by frozen validation programmes.

For a runnable reviewer-revision exercise, use the revision-package quickstart.

Evidence and denominator vocabulary

The evidence vocabulary distinguishes:

• the declared Cartesian specification space from the subset accepted by valid_if;
• a valid branch that executes successfully from a valid branch that fails technically;
• documentation-ledger terms from actual run_specs() return fields;
• non-finite endpoint values from scientific null effects;
• submitted evidence from later reviewer-requested amendments;
• general audit language from frozen, case-specific outcome labels.

Use the reference lookup walkthrough for one synthetic example that moves between these references without turning them into scientific decision rules.

Provenance and version identity

The stable public package release and the continuously updated documentation are different identities. The documentation provenance page records the exact GitHub Pages build revision and explains when to record the package version, development commit, and DOI or frozen artifact.

Source-of-truth hierarchy

Reference pages can move forward on main; they do not rewrite frozen release assets or protocol-bound evidence.

Frozen outcome boundary

The canonical validation outcomes remain:

• GazeBase: incomplete
• Korthals: robust_negative
• Pedrotti/de Chambrier: materially_fragile

These labels are protocol-bound records, not generic statuses to assign to a synthetic example, a new dataset, or an unrelated manuscript.

For action-oriented help, return to the Documentation hub or What should I do next?.