Member Junction
    Preparing search index...

    Interface PredictiveStudioModelingPlanSpec

    The strongly-typed modeling plan to execute. Mirrors ModelingPlanSpec from @memberjunction/predictive-studio-core — the deterministic orchestrator runs its ProposedExperiments as waves. Must be approved (Approved=true) — execution is gated on user approval.

    interface PredictiveStudioModelingPlanSpec {
        Approved?: boolean;
        CandidateFeatures: {
            Kind: "embedding" | "numeric" | "categorical" | "llm-derived";
            Name: string;
            SourceRef: string;
            Why: string;
        }[];
        CandidateSources: {
            Kind: | "Entity"
            | "Query"
            | "ExternalEntity"
            | "VectorSet"
            | "FeaturePipeline";
            Ref: string;
            Why: string;
        }[];
        Goal: string;
        LeakageNotes: { Action: "exclude"
        | "allow"; Field: string; Risk: string }[];
        ProposedBudget: PredictiveStudioBudget;
        ProposedExperiments: {
            AlgorithmName: string;
            FeatureSet: string[];
            Hyperparameters?: Record<string, unknown>;
            Label: string;
            Priority: number;
            Rationale: string;
        }[];
        TargetDefinition: {
            AsOfStrategy?: {
                Column?: string;
                Mode: "column"
                | "none"
                | "offset";
                OffsetDays?: number;
            };
            EntityName: string;
            ProblemType: "classification"
            | "regression";
            SuccessMetric: string;
            TargetVariable: string;
        };
        ValidationStrategy: {
            K?: number;
            LockedHoldoutFraction: number;
            Strategy: "train_test_split"
            | "kfold"
            | "holdout";
            TestSize?: number;
        };
    }
    Index

    Properties

    Approved?: boolean

    User approval gate — execution does not begin until this is true.

    CandidateFeatures: {
        Kind: "embedding" | "numeric" | "categorical" | "llm-derived";
        Name: string;
        SourceRef: string;
        Why: string;
    }[]

    Candidate features proposed by the Data Scout, each with rationale.

    CandidateSources: {
        Kind:
            | "Entity"
            | "Query"
            | "ExternalEntity"
            | "VectorSet"
            | "FeaturePipeline";
        Ref: string;
        Why: string;
    }[]

    Candidate feed-in sources proposed by the Data Scout, each with rationale.

    Goal: string

    Business objective, refined from the user's initial goal.

    LeakageNotes: { Action: "exclude" | "allow"; Field: string; Risk: string }[]

    Leakage risks identified by the Data Scout and the chosen action per field.

    ProposedBudget: PredictiveStudioBudget

    Proposed resource budget for the experiment session.

    ProposedExperiments: {
        AlgorithmName: string;
        FeatureSet: string[];
        Hyperparameters?: Record<string, unknown>;
        Label: string;
        Priority: number;
        Rationale: string;
    }[]

    Ranked experiments proposed by the Experiment Designer (feature combos × algorithms × hyperparameters).

    TargetDefinition: {
        AsOfStrategy?: {
            Column?: string;
            Mode: "column" | "none" | "offset";
            OffsetDays?: number;
        };
        EntityName: string;
        ProblemType: "classification"
        | "regression";
        SuccessMetric: string;
        TargetVariable: string;
    }

    Precise definition of what is being predicted.

    Type Declaration

    • OptionalAsOfStrategy?: { Column?: string; Mode: "column" | "none" | "offset"; OffsetDays?: number }

      Optional point-in-time assembly strategy.

    • EntityName: string

      Training-unit entity (e.g. "Members").

    • ProblemType: "classification" | "regression"

      Classification or regression.

    • SuccessMetric: string

      The deterministic success metric driving the search (e.g. AUC / F1 / Accuracy / RMSE).

    • TargetVariable: string

      Label expression/column.

    ValidationStrategy: {
        K?: number;
        LockedHoldoutFraction: number;
        Strategy: "train_test_split" | "kfold" | "holdout";
        TestSize?: number;
    }

    Validation strategy for the search.