Member Junction
    Preparing search index...

    Everything a snapshot is built from: the unit read, the assembled matrix, the row roles and where to write.

    interface SnapshotBuildInput {
        Assembled: {
            CategoryLevels: ReadonlyMap<string, readonly string[]>;
            ColumnProvenance: readonly ColumnProvenance[];
            Columns: readonly AssembledColumn[];
            Coverage: readonly ChangeHistoryCoverage[];
            ExcludedRowIDs: ReadonlySet<string>;
            Preprocessing: readonly PreprocessingOp[];
            Rows: readonly AssembledRow[];
            Status: "assembled";
            UncoveredRowsExcluded: readonly UncoveredRowsCount[];
        };
        ContextUser?: UserInfo;
        EntityFactory: IEntityFactory;
        EvaluationProtocolID: string;
        ExistingByContentHash: (
            contentHash: string,
        ) => Promise<MJMLTrainingSnapshotEntity>;
        Features: readonly FeatureColumnSpec[];
        FeatureSpecVersion: number;
        Files: ISnapshotFileStore;
        IncumbentScore: boolean;
        PipelineID: string;
        Roles: ReadonlyMap<string, SnapshotRowRole>;
        SliceFields: readonly string[];
        Unit: PredictionUnitSpec;
        UnitRead: {
            Counts: UnitResolutionCounts;
            DataCutoff: Date;
            RowEntity: AssemblyEntityInfo;
            Rows: readonly UnitRow[];
            Status: "read";
        };
    }
    Index

    Properties

    Assembled: {
        CategoryLevels: ReadonlyMap<string, readonly string[]>;
        ColumnProvenance: readonly ColumnProvenance[];
        Columns: readonly AssembledColumn[];
        Coverage: readonly ChangeHistoryCoverage[];
        ExcludedRowIDs: ReadonlySet<string>;
        Preprocessing: readonly PreprocessingOp[];
        Rows: readonly AssembledRow[];
        Status: "assembled";
        UncoveredRowsExcluded: readonly UncoveredRowsCount[];
    }

    Type Declaration

    • ReadonlyCategoryLevels: ReadonlyMap<string, readonly string[]>

      The kept levels of every categorical column, by column name: persist them with the model and pass them back at scoring.

    • ReadonlyColumnProvenance: readonly ColumnProvenance[]
    • ReadonlyColumns: readonly AssembledColumn[]
    • ReadonlyCoverage: readonly ChangeHistoryCoverage[]
    • ReadonlyExcludedRowIDs: ReadonlySet<string>
    • ReadonlyPreprocessing: readonly PreprocessingOp[]
    • ReadonlyRows: readonly AssembledRow[]
    • ReadonlyStatus: "assembled"
    • ReadonlyUncoveredRowsExcluded: readonly UncoveredRowsCount[]
    ContextUser?: UserInfo
    EntityFactory: IEntityFactory
    EvaluationProtocolID: string
    ExistingByContentHash: (
        contentHash: string,
    ) => Promise<MJMLTrainingSnapshotEntity>

    The saved snapshot with this content hash, or null when there is none.

    Features: readonly FeatureColumnSpec[]
    FeatureSpecVersion: number
    IncumbentScore: boolean

    Write the incumbent-score column (the bound protocol declares an incumbent-heuristic baseline).

    PipelineID: string
    Roles: ReadonlyMap<string, SnapshotRowRole>
    SliceFields: readonly string[]

    The protocol's slice subgroup fields, written as __ps_slice:<field> columns (empty when the protocol declares none).

    UnitRead: {
        Counts: UnitResolutionCounts;
        DataCutoff: Date;
        RowEntity: AssemblyEntityInfo;
        Rows: readonly UnitRow[];
        Status: "read";
    }