Enum StudyEvent

#[non_exhaustive]pub enum StudyEvent {
    StudyCreated {
        study: StudyId,
        worker: WorkerId,
        operation: OperationId,
    },
    StudyLoaded {
        study: StudyId,
        worker: WorkerId,
        existing_trials: u64,
        operation: OperationId,
    },
    SpaceGrowthDecided {
        study: StudyId,
        param: u32,
        side: Side,
        reason: GrowthReason,
        operation: OperationId,
    },
    OptimizationStarted {
        study: StudyId,
        worker: WorkerId,
        parallelism: usize,
        operation: OperationId,
    },
    OptimizationFinished {
        study: StudyId,
        worker: WorkerId,
        succeeded: bool,
        operation: OperationId,
    },
    TrialStateChanged {
        study: StudyId,
        trial: TrialId,
        number: TrialNumber,
        worker: WorkerId,
        from: TrialState,
        to: TrialState,
        operation: OperationId,
    },
    TrialAbandoned {
        study: StudyId,
        trial: TrialId,
        number: TrialNumber,
        worker: WorkerId,
        operation: OperationId,
    },
}

Expand description

A committed lifecycle event emitted by a Study.

The event carries identifiers and state only. Parameter values, objective values, command arguments, storage paths, and checkpoint references are deliberately excluded so telemetry cannot leak experiment data by default.

§Correlation

Every variant carries an OperationId. Events emitted by one unit of lifecycle work — the ask that starts a trial and the tell that finishes it, the start and the end of one optimize run — share one id, which is what lets a consumer reassemble a trace from an interleaved stream. The id is unique only within a worker, so the correlation key is the pair (worker, operation); see OperationId for why grouping by the operation alone quietly produces wrong answers.

OperationId::NONE means this handle has no operation to attribute the event to — a trial finalized by a handle that did not start it, for instance. It is an honest gap, and consumers must treat it as “uncorrelated” rather than as an operation in its own right.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

§

StudyCreated

A new study was persisted and its runtime seams were initialized.

Fields

§study: StudyId

Storage-local study identity.

§worker: WorkerId

Identity of the handle that created it.

§operation: OperationId

The create call this event belongs to.

§

StudyLoaded

An existing study was loaded and its runtime seams were restored.

Fields

§study: StudyId

Storage-local study identity.

§worker: WorkerId

Identity of the handle that loaded it.

§existing_trials: u64

Trials already present when the handle was assembled.

§operation: OperationId

The load call this event belongs to.

§

SpaceGrowthDecided

The growth rule took a decision for one side of one open parameter (the open-search-spaces plan §13.2) — a movement (Crowding, VetoRolledBack) or a brake, one variant for all seven GrowthReasons, so a live consumer can tell “not crowded” from “crowded and braked”.

Carries an index, not a name, and no bounds: this enum holds identifiers and state only (the privacy contract above), and a bound is unmistakably experiment data. param indexes the name-sorted parameter list of the widened space — the only ordering defined for both declared and define-by-run spaces — and each trial’s own recorded distributions remain the authoritative range record.