{"entrypoint":"@insiderfinance/totalfinance/research/artifacts","package":"@insiderfinance/totalfinance","domain":"research","stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","url":"/reference/totalfinance/research/artifacts","exports":[{"id":"@insiderfinance/totalfinance/research/artifacts#AbnormalReturnDelta","name":"AbnormalReturnDelta","kind":"interface","url":"/reference/totalfinance/research/artifacts#AbnormalReturnDelta","signature":"export interface AbnormalReturnDelta {\n    tradingSessionOffset: number;\n    baselineAverageAbnormalReturn: number | null;\n    candidateAverageAbnormalReturn: number | null;\n    absoluteDelta: number | null;\n    baselineCumulativeAverageAbnormalReturn: number | null;\n    candidateCumulativeAverageAbnormalReturn: number | null;\n    cumulativeAbsoluteDelta: number | null;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"absoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"baselineAverageAbnormalReturn","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"baselineCumulativeAverageAbnormalReturn","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"candidateAverageAbnormalReturn","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"candidateCumulativeAverageAbnormalReturn","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"cumulativeAbsoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"tradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#CountDelta","name":"CountDelta","kind":"interface","url":"/reference/totalfinance/research/artifacts#CountDelta","signature":"export interface CountDelta {\n    reason: string;\n    baselineCount: number;\n    candidateCount: number;\n    delta: number;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"baselineCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"candidateCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"delta","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"reason","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#HygieneBacktestOverfitting","name":"HygieneBacktestOverfitting","kind":"interface","url":"/reference/totalfinance/research/artifacts#HygieneBacktestOverfitting","signature":"/** `backtestOverfittingProbability`'s result — risk's `BacktestOverfittingProbabilityResult`, structurally. */\nexport interface HygieneBacktestOverfitting {\n    backtestOverfittingProbability: number;\n    combinations: number;\n    splits: number;\n    observations: number;\n    trials: number;\n    medianLogit: number;\n    assumptions: {\n        conventionsVersion: string;\n        [k: string]: unknown;\n    };\n    diagnostics: {\n        warnings: QuantWarning[];\n    };\n}","description":"`backtestOverfittingProbability`'s result — risk's `BacktestOverfittingProbabilityResult`, structurally.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfittingProbability","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"combinations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"medianLogit","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"splits","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"trials","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#HygieneDeflatedSharpe","name":"HygieneDeflatedSharpe","kind":"interface","url":"/reference/totalfinance/research/artifacts#HygieneDeflatedSharpe","signature":"/** `deflatedSharpeRatio`'s result — risk's `DeflatedSharpeResult`, structurally. */\nexport interface HygieneDeflatedSharpe {\n    assumptions: {\n        conventionsVersion: string;\n        [k: string]: unknown;\n    };\n    diagnostics: {\n        warnings: QuantWarning[];\n    };\n    /** `null` when the statistics carried no Sharpe (a zero-variance series). */\n    deflatedSharpe: number | null;\n    probabilisticSharpe: number | null;\n    expectedMaxSharpe: number;\n    trialCount: number;\n}","description":"`deflatedSharpeRatio`'s result — risk's `DeflatedSharpeResult`, structurally.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe","type":"number | null","description":"`null` when the statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#HygieneLeakageReport","name":"HygieneLeakageReport","kind":"interface","url":"/reference/totalfinance/research/artifacts#HygieneLeakageReport","signature":"/** `detectLeakage`'s report — risk's `LeakageReport`, structurally. */\nexport interface HygieneLeakageReport {\n    assumptions: {\n        conventionsVersion: string;\n        [k: string]: unknown;\n    };\n    diagnostics: {\n        warnings: QuantWarning[];\n    };\n    clean: boolean;\n    leaks: Array<{\n        split: number;\n        overlapCount: number;\n        sample: number[];\n    }>;\n}","description":"`detectLeakage`'s report — risk's `LeakageReport`, structurally.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"clean","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"leaks","type":"{ split: number; overlapCount: number; sample: number[]; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#HygieneMultipleTest","name":"HygieneMultipleTest","kind":"interface","url":"/reference/totalfinance/research/artifacts#HygieneMultipleTest","signature":"/** `adjustPValues`' result — risk's `MultipleTestResult`, structurally. */\nexport interface HygieneMultipleTest {\n    method: 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg';\n    alpha: number;\n    adjusted: number[];\n    rejected: boolean[];\n}","description":"`adjustPValues`' result — risk's `MultipleTestResult`, structurally.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"adjusted","type":"number[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"alpha","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"method","type":"'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rejected","type":"boolean[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#HygieneParameterSweep","name":"HygieneParameterSweep","kind":"interface","url":"/reference/totalfinance/research/artifacts#HygieneParameterSweep","signature":"/** `parameterSweepDiagnostics`' result — risk's `ParameterSweepResult`, structurally. */\nexport interface HygieneParameterSweep {\n    trialCount: number;\n    bestSharpe: number;\n    meanSharpe: number;\n    varianceSharpe: number;\n    expectedMaxSharpe: number;\n    /** `null` when the selected statistics carried no Sharpe (a zero-variance series). */\n    deflatedSharpe: number | null;\n    probabilisticSharpe: number | null;\n}","description":"`parameterSweepDiagnostics`' result — risk's `ParameterSweepResult`, structurally.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"bestSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe","type":"number | null","description":"`null` when the selected statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"meanSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"varianceSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#HygieneResearchVerdict","name":"HygieneResearchVerdict","kind":"interface","url":"/reference/totalfinance/research/artifacts#HygieneResearchVerdict","signature":"/** `researchProtocol`'s verdict — risk's `ResearchVerdict`, structurally. */\nexport interface HygieneResearchVerdict {\n    verdict: 'significant' | 'inconclusive' | 'likely-overfit';\n    /** Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`. */\n    inSample: {\n        sharpe: number | null;\n        annualizedSharpe: number | null;\n        observations: number;\n    };\n    deflatedSharpe: number | null;\n    probabilisticSharpe: number | null;\n    expectedMaxSharpe: number;\n    trialCount: number;\n    /** `Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal. */\n    minTrackRecordLength: number;\n    outOfSample?: {\n        sharpe: number | null;\n        annualizedSharpe: number | null;\n        degradation: number | null;\n    };\n    rationale: string;\n    assumptions: {\n        conventionsVersion: string;\n        confidence: number;\n        periodsPerYear: number;\n    };\n    diagnostics: {\n        warnings: QuantWarning[];\n    };\n}","description":"`researchProtocol`'s verdict — risk's `ResearchVerdict`, structurally.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"assumptions","type":"{ confidence: number; conventionsVersion: string; periodsPerYear: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.confidence","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.periodsPerYear","type":"number","description":"","optional":false,"defaultValue":null,"unit":"per year (count)"},{"name":"deflatedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"inSample","type":"{ annualizedSharpe: number | null; observations: number; sharpe: number | null; }","description":"Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"inSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"inSample.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"inSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"minTrackRecordLength","type":"number","description":"`Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal.","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"outOfSample","type":"{ annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"outOfSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"outOfSample.degradation","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"outOfSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rationale","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"verdict","type":"'significant' | 'inconclusive' | 'likely-overfit'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#HygieneVerdictSection","name":"HygieneVerdictSection","kind":"interface","url":"/reference/totalfinance/research/artifacts#HygieneVerdictSection","signature":"export interface HygieneVerdictSection {\n    baseline: string;\n    candidate: string;\n    changed: boolean;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"baseline","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"candidate","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"changed","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#IdListSection","name":"IdListSection","kind":"interface","url":"/reference/totalfinance/research/artifacts#IdListSection","signature":"export interface IdListSection {\n    count: number;\n    /** Listed up to `limits.listedIds`; the remainder is counted. */\n    ids: string[];\n    remainderCount: number;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#InputOf","name":"InputOf","kind":"type","url":"/reference/totalfinance/research/artifacts#InputOf","signature":"export type InputOf<K extends ResearchRunKind> = ResearchRunInputs[K];","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[]},{"id":"@insiderfinance/totalfinance/research/artifacts#KeyedDelta","name":"KeyedDelta","kind":"interface","url":"/reference/totalfinance/research/artifacts#KeyedDelta","signature":"export interface KeyedDelta<Key> {\n    key: Key;\n    baselineValue: number | null;\n    candidateValue: number | null;\n    absoluteDelta: number | null;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"absoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"baselineValue","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"currency amount (the field or record currency)"},{"name":"candidateValue","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"currency amount (the field or record currency)"},{"name":"key","type":"Key","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#MembershipSection","name":"MembershipSection","kind":"interface","url":"/reference/totalfinance/research/artifacts#MembershipSection","signature":"export interface MembershipSection {\n    entered: IdListSection;\n    exited: IdListSection;\n    kept: IdListSection;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"entered","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"entered.count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"entered.ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"entered.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"exited","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"exited.count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"exited.ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"exited.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"kept","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"kept.count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"kept.ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"kept.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#NamedDelta","name":"NamedDelta","kind":"interface","url":"/reference/totalfinance/research/artifacts#NamedDelta","signature":"export interface NamedDelta {\n    name: string;\n    baselineValue: number | null;\n    candidateValue: number | null;\n    absoluteDelta: number | null;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"absoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"baselineValue","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"currency amount (the field or record currency)"},{"name":"candidateValue","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"currency amount (the field or record currency)"},{"name":"name","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#PortfolioMembership","name":"PortfolioMembership","kind":"interface","url":"/reference/totalfinance/research/artifacts#PortfolioMembership","signature":"export interface PortfolioMembership {\n    quantileIndex: number;\n    membership: MembershipSection;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"membership","type":"MembershipSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.entered","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.entered.count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.entered.ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.entered.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"membership.exited","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.exited.count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.exited.ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.exited.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"membership.kept","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.kept.count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.kept.ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.kept.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"quantileIndex","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#RESEARCH_RUN_ARTIFACT_TYPE","name":"RESEARCH_RUN_ARTIFACT_TYPE","kind":"value","url":"/reference/totalfinance/research/artifacts#RESEARCH_RUN_ARTIFACT_TYPE","signature":"export declare const RESEARCH_RUN_ARTIFACT_TYPE: 'research.run';","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[]},{"id":"@insiderfinance/totalfinance/research/artifacts#RESEARCH_RUN_KINDS","name":"RESEARCH_RUN_KINDS","kind":"value","url":"/reference/totalfinance/research/artifacts#RESEARCH_RUN_KINDS","signature":"export declare const RESEARCH_RUN_KINDS: Readonly<Record<ResearchRunKind, ResearchRunKindDescriptor>>;","description":"The frozen descriptor per run kind — Program 5's registry metadata without a registry.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[]},{"id":"@insiderfinance/totalfinance/research/artifacts#RESEARCH_RUN_LIMITS","name":"RESEARCH_RUN_LIMITS","kind":"value","url":"/reference/totalfinance/research/artifacts#RESEARCH_RUN_LIMITS","signature":"export declare const RESEARCH_RUN_LIMITS: Readonly<{ maximumEmbeddedBytes: Readonly<{ default: 1048576; maximum: 8388608; }>; embeddedRowLimit: Readonly<{ default: 5000; maximum: 50000; }>; maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; gridPoints: Readonly<{ default: 256; maximum: 4096; }>; restarts: Readonly<{ maximum: 64; }>; holdoutEvaluations: Readonly<{ maximum: 100000; }>; listedIds: Readonly<{ default: 200; maximum: 10000; }>; }>;","description":"Decision 9's bounded-work table (core's `ARTIFACT_WORK_LIMITS`, re-exported for this subpath's callers).","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"embeddedRowLimit","type":"Readonly<{ default: 5000; maximum: 50000; }>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"embeddedRowLimit.default","type":"5000","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"embeddedRowLimit.maximum","type":"50000","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"gridPoints","type":"Readonly<{ default: 256; maximum: 4096; }>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"gridPoints.default","type":"256","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"gridPoints.maximum","type":"4096","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"holdoutEvaluations","type":"Readonly<{ maximum: 100000; }>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"holdoutEvaluations.maximum","type":"100000","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"listedIds","type":"Readonly<{ default: 200; maximum: 10000; }>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"listedIds.default","type":"200","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"listedIds.maximum","type":"10000","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumDifferences","type":"Readonly<{ default: 1000; maximum: 100000; }>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumDifferences.default","type":"1000","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumDifferences.maximum","type":"100000","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumEmbeddedBytes","type":"Readonly<{ default: 1048576; maximum: 8388608; }>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumEmbeddedBytes.default","type":"1048576","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumEmbeddedBytes.maximum","type":"8388608","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumLeaves","type":"Readonly<{ default: 2000000; maximum: 2000000; }>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumLeaves.default","type":"2000000","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumLeaves.maximum","type":"2000000","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"restarts","type":"Readonly<{ maximum: 64; }>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"restarts.maximum","type":"64","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#RankMove","name":"RankMove","kind":"interface","url":"/reference/totalfinance/research/artifacts#RankMove","signature":"export interface RankMove {\n    instrumentId: string;\n    baselineRank: number;\n    candidateRank: number;\n    /** candidate − baseline (positive = moved down the ranking). */\n    delta: number;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"baselineRank","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"candidateRank","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"delta","type":"number","description":"candidate − baseline (positive = moved down the ranking).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"instrumentId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#RankMovesSection","name":"RankMovesSection","kind":"interface","url":"/reference/totalfinance/research/artifacts#RankMovesSection","signature":"export interface RankMovesSection {\n    /** Instruments ranked on both sides whose rank changed. */\n    movedCount: number;\n    /** The largest movers by |delta|, listed up to `limits.listedIds`. */\n    movers: RankMove[];\n    remainderCount: number;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"movedCount","type":"number","description":"Instruments ranked on both sides whose rank changed.","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"movers","type":"RankMove[]","description":"The largest movers by |delta|, listed up to `limits.listedIds`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ReadResearchRunResult","name":"ReadResearchRunResult","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ReadResearchRunResult","signature":"export interface ReadResearchRunResult<Kind extends ResearchRunKind = ResearchRunKind> {\n    report: ResearchRunReport<Kind>;\n    artifact: AnalysisArtifact;\n    /** Envelope-level migrations applied by the Gate B read door. */\n    migrationsApplied: AppliedMigration[];\n    /** Report-level (run-version) migrations applied under `research.run:<kind>` — the same echo shape as the fitted-model read doors. */\n    modelMigrationsApplied: AppliedMigration[];\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"artifact","type":"AnalysisArtifact","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.artifactType","type":"string","description":"Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.conventionsVersion","type":"string","description":"The library conventions revision the artifact was CREATED under — stamped from core's\n`CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and\nnever caller-set. Covered by the id; validated as a non-empty string on read.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.createdFrom","type":"string[]","description":"Parent artifact ids this one was derived from, oldest first.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.id","type":"string","description":"Content hash of the body (everything but `id` and `provenance`) — stamped at creation.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.inputs","type":"import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.inputs.inputsHash","type":"string","description":"Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set,\nand RECOMPUTED from the stored fields on every validation pass (create and read), so a\ntampered hash or tampered inputs are refused even when the outer id was re-minted to match.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.inputs.parameters","type":"unknown","description":"The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.inputs.snapshotHash","type":"string","description":"`marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.kind","type":"'totalfinance.analysis-artifact'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.producedBy","type":"import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.producedBy.libraryVersion","type":"string","description":"The TotalFinance version that produced it, when the caller knows it (e.g. from package.json).","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.producedBy.operation","type":"string","description":"The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.provenance","type":"Provenance","description":"Data lineage, caller-supplied, outside the id (labels are not identity).","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.provenance.asOf","type":"number","description":"","optional":true,"defaultValue":null,"unit":"an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)"},{"name":"artifact.provenance.dataset","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.provenance.provider","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.provenance.receivedAt","type":"number","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.provenance.requestId","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.provenance.sourceVersion","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.provenance.warnings","type":"QuantWarning[]","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.result","type":"Record<string, unknown>","description":"The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.schemaVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifact.tables","type":"Record<string, TableHandle>","description":"Named large-table references — rows live where storage puts them, identity lives here.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"migrationsApplied","type":"AppliedMigration[]","description":"Envelope-level migrations applied by the Gate B read door.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"modelMigrationsApplied","type":"AppliedMigration[]","description":"Report-level (run-version) migrations applied under `research.run:<kind>` — the same echo shape as the fitted-model read doors.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report","type":"ResearchRunReport<Kind>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions","type":"{ conventionsVersion: string; kind: Kind; runVersion: number; operation: string; replayable: boolean; nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; projection: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions.embeddedRowLimit","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions.inputPolicy","type":"'embedded' | 'referenced'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions.kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions.nonReplayableField","type":"string | null","description":"The callback field that made the run non-replayable, when one did.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions.operation","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions.projection","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions.replayable","type":"boolean","description":"`false` exactly when a non-serializable callback participated.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.assumptions.runVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.diagnostics","type":"{ warnings: QuantWarning[]; embeddedRows: number; referencedRows: number; runWarningCount: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.diagnostics.embeddedRows","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.diagnostics.referencedRows","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.diagnostics.runWarningCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"report.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene","type":"ResearchHygieneBlock | null","description":"Statistical-hygiene results the caller attached, verbatim — computed by @insiderfinance/totalfinance/risk, never here.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneBacktestOverfitting","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.backtestOverfittingProbability","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.combinations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.medianLogit","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.splits","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.backtestOverfitting.trials","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.deflatedSharpe","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneDeflatedSharpe","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.deflatedSharpe.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.deflatedSharpe.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.deflatedSharpe.deflatedSharpe","type":"number | null","description":"`null` when the statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.deflatedSharpe.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.deflatedSharpe.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.deflatedSharpe.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.deflatedSharpe.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.deflatedSharpe.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"report.hygiene.leakage","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneLeakageReport","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.leakage.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.leakage.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.leakage.clean","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.leakage.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.leakage.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.leakage.leaks","type":"{ split: number; overlapCount: number; sample: number[]; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.multipleTesting","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneMultipleTest","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.multipleTesting.adjusted","type":"number[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.multipleTesting.alpha","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.multipleTesting.method","type":"'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.multipleTesting.rejected","type":"boolean[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.parameterSweep","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneParameterSweep","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.parameterSweep.bestSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.parameterSweep.deflatedSharpe","type":"number | null","description":"`null` when the selected statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.parameterSweep.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.parameterSweep.meanSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.parameterSweep.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.parameterSweep.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"report.hygiene.parameterSweep.varianceSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneResearchVerdict","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.assumptions","type":"{ conventionsVersion: string; confidence: number; periodsPerYear: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.assumptions.confidence","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.assumptions.periodsPerYear","type":"number","description":"","optional":false,"defaultValue":null,"unit":"per year (count)"},{"name":"report.hygiene.protocol.deflatedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.inSample","type":"{ sharpe: number | null; annualizedSharpe: number | null; observations: number; }","description":"Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.inSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.inSample.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.inSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.minTrackRecordLength","type":"number","description":"`Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal.","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"report.hygiene.protocol.outOfSample","type":"{ sharpe: number | null; annualizedSharpe: number | null; degradation: number | null; }","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.outOfSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.outOfSample.degradation","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.outOfSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.rationale","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.hygiene.protocol.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"report.hygiene.protocol.verdict","type":"'significant' | 'inconclusive' | 'likely-overfit'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.inputs","type":"Referenced<InputOf<Kind>>","description":"The operation's input with bulk rows either embedded or replaced by verified table references.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.recipe","type":"FactorRecipe | null","description":"The versioned recipe the caller says produced the factor, when one did.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.recipe.direction","type":"'higher-is-better' | 'lower-is-better'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.recipe.disclosure","type":"string","description":"The disclosure every canonical recipe carries: a definition, not the definition.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.recipe.features","type":"readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.recipe.lagTradingSessions","type":"number","description":"Sessions between the information date and use — the lookahead guard.","optional":false,"defaultValue":null,"unit":"trading sessions"},{"name":"report.recipe.missingValuePolicy","type":"'exclude' | 'renormalize-weights'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.recipe.neutralization","type":"'none' | 'sector' | 'sector-and-size'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.recipe.recipeName","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.recipe.recipeVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.referencedData","type":"Record<string, TableHandle>","description":"Table references for every bulk row set that was not embedded (Gate B TableHandle).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.run","type":"RunOf<Kind>","description":"The direct operation's result, verbatim.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"report.runVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#Referenced","name":"Referenced","kind":"type","url":"/reference/totalfinance/research/artifacts/page-2#Referenced","signature":"/**\n * The stored form of an input: every bulk array may be a `TableHandle` instead of its rows, and a\n * caller function is never stored (the run is recorded non-replayable and the field omitted).\n */\nexport type Referenced<T> = T extends (...args: never[]) => unknown ? never : T extends readonly (infer Element)[] ? readonly Referenced<Element>[] | TableHandle : T extends object ? {\n    [P in keyof T]: Referenced<T[P]>;\n} : T;","description":"The stored form of an input: every bulk array may be a `TableHandle` instead of its rows, and a\ncaller function is never stored (the run is recorded non-replayable and the field omitted).","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchHygieneBlock","name":"ResearchHygieneBlock","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ResearchHygieneBlock","signature":"/** The closed block: every member optional, every present member verbatim. */\nexport interface ResearchHygieneBlock {\n    protocol?: HygieneResearchVerdict;\n    deflatedSharpe?: HygieneDeflatedSharpe;\n    backtestOverfitting?: HygieneBacktestOverfitting;\n    leakage?: HygieneLeakageReport;\n    parameterSweep?: HygieneParameterSweep;\n    multipleTesting?: HygieneMultipleTest;\n}","description":"The closed block: every member optional, every present member verbatim.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"backtestOverfitting","type":"HygieneBacktestOverfitting","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.backtestOverfittingProbability","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.combinations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.medianLogit","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.splits","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"backtestOverfitting.trials","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe","type":"HygieneDeflatedSharpe","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe.deflatedSharpe","type":"number | null","description":"`null` when the statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"deflatedSharpe.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"leakage","type":"HygieneLeakageReport","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"leakage.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"leakage.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"leakage.clean","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"leakage.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"leakage.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"leakage.leaks","type":"{ split: number; overlapCount: number; sample: number[]; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"multipleTesting","type":"HygieneMultipleTest","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"multipleTesting.adjusted","type":"number[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"multipleTesting.alpha","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"multipleTesting.method","type":"'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"multipleTesting.rejected","type":"boolean[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parameterSweep","type":"HygieneParameterSweep","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"parameterSweep.bestSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parameterSweep.deflatedSharpe","type":"number | null","description":"`null` when the selected statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parameterSweep.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parameterSweep.meanSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parameterSweep.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parameterSweep.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"parameterSweep.varianceSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol","type":"HygieneResearchVerdict","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.assumptions","type":"{ confidence: number; conventionsVersion: string; periodsPerYear: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.assumptions.confidence","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.assumptions.periodsPerYear","type":"number","description":"","optional":false,"defaultValue":null,"unit":"per year (count)"},{"name":"protocol.deflatedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.inSample","type":"{ annualizedSharpe: number | null; observations: number; sharpe: number | null; }","description":"Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.inSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.inSample.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.inSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.minTrackRecordLength","type":"number","description":"`Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal.","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"protocol.outOfSample","type":"{ annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.outOfSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.outOfSample.degradation","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.outOfSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.rationale","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"protocol.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"protocol.verdict","type":"'significant' | 'inconclusive' | 'likely-overfit'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunArtifactInput","name":"ResearchRunArtifactInput","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunArtifactInput","signature":"export interface ResearchRunArtifactInput<Kind extends ResearchRunKind> {\n    kind: Kind;\n    /** The direct operation's result, verbatim. */\n    run: RunOf<Kind>;\n    /** The operation's input as it was called — rows included; a caller function is recorded and not stored. */\n    input: InputOf<Kind>;\n    /** Concrete row-set labels (`observations`, `horizons[0].forwardReturns`) to store by `TableHandle` instead of embedding. */\n    referenceRowSets?: readonly string[];\n    /** Storage locators to stamp on the minted handles, keyed by row-set label. */\n    locators?: Record<string, string>;\n    /** Up to six verbatim @insiderfinance/totalfinance/risk results — validated structurally, stored verbatim, never recomputed. */\n    hygiene?: ResearchHygieneBlock;\n    /** The versioned factor recipe that produced the factor, stored verbatim (covered by the artifact id). */\n    recipe?: FactorRecipe;\n    snapshotHash?: string;\n    libraryVersion?: string;\n    /** Parent artifact ids (a transform, a prior study, a portfolio set) so lineage is walkable. */\n    createdFrom?: string[];\n    provenance?: Provenance;\n    limits?: ResearchRunArtifactLimits;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"createdFrom","type":"string[]","description":"Parent artifact ids (a transform, a prior study, a portfolio set) so lineage is walkable.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene","type":"ResearchHygieneBlock","description":"Up to six verbatim @insiderfinance/totalfinance/risk results — validated structurally, stored verbatim, never recomputed.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneBacktestOverfitting","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.backtestOverfittingProbability","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.combinations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.medianLogit","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.splits","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.trials","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneDeflatedSharpe","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.deflatedSharpe","type":"number | null","description":"`null` when the statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"hygiene.leakage","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneLeakageReport","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.clean","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.leaks","type":"{ split: number; overlapCount: number; sample: number[]; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneMultipleTest","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting.adjusted","type":"number[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting.alpha","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting.method","type":"'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting.rejected","type":"boolean[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneParameterSweep","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.bestSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.deflatedSharpe","type":"number | null","description":"`null` when the selected statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.meanSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"hygiene.parameterSweep.varianceSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneResearchVerdict","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.assumptions","type":"{ confidence: number; conventionsVersion: string; periodsPerYear: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.assumptions.confidence","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.assumptions.periodsPerYear","type":"number","description":"","optional":false,"defaultValue":null,"unit":"per year (count)"},{"name":"hygiene.protocol.deflatedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.inSample","type":"{ annualizedSharpe: number | null; observations: number; sharpe: number | null; }","description":"Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.inSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.inSample.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.inSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.minTrackRecordLength","type":"number","description":"`Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal.","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"hygiene.protocol.outOfSample","type":"{ annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.outOfSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.outOfSample.degradation","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.outOfSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.rationale","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"hygiene.protocol.verdict","type":"'significant' | 'inconclusive' | 'likely-overfit'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"input","type":"InputOf<Kind>","description":"The operation's input as it was called — rows included; a caller function is recorded and not stored.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"libraryVersion","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"limits","type":"ResearchRunArtifactLimits","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"limits.embeddedRowLimit","type":"number","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"limits.maximumEmbeddedBytes","type":"number","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"locators","type":"Record<string, string>","description":"Storage locators to stamp on the minted handles, keyed by row-set label.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"provenance","type":"Provenance","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"provenance.asOf","type":"number","description":"","optional":true,"defaultValue":null,"unit":"an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)"},{"name":"provenance.dataset","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"provenance.provider","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"provenance.receivedAt","type":"number","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"provenance.requestId","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"provenance.sourceVersion","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"provenance.warnings","type":"QuantWarning[]","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe","type":"FactorRecipe","description":"The versioned factor recipe that produced the factor, stored verbatim (covered by the artifact id).","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.direction","type":"'higher-is-better' | 'lower-is-better'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.disclosure","type":"string","description":"The disclosure every canonical recipe carries: a definition, not the definition.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.features","type":"readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.lagTradingSessions","type":"number","description":"Sessions between the information date and use — the lookahead guard.","optional":false,"defaultValue":null,"unit":"trading sessions"},{"name":"recipe.missingValuePolicy","type":"'exclude' | 'renormalize-weights'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.neutralization","type":"'none' | 'sector' | 'sector-and-size'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.recipeName","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.recipeVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"referenceRowSets","type":"readonly string[]","description":"Concrete row-set labels (`observations`, `horizons[0].forwardReturns`) to store by `TableHandle` instead of embedding.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"run","type":"RunOf<Kind>","description":"The direct operation's result, verbatim.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"snapshotHash","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunArtifactLimits","name":"ResearchRunArtifactLimits","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunArtifactLimits","signature":"export interface ResearchRunArtifactLimits {\n    maximumEmbeddedBytes?: number;\n    embeddedRowLimit?: number;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"embeddedRowLimit","type":"number","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumEmbeddedBytes","type":"number","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunComparison","name":"ResearchRunComparison","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunComparison","signature":"export interface ResearchRunComparison<Kind extends ResearchRunKind = ResearchRunKind> {\n    kind: Kind;\n    artifactIds: {\n        baseline: string | null;\n        candidate: string | null;\n    };\n    sameUniverse: boolean | null;\n    sameAsOf: boolean | null;\n    sameFilter: boolean | null;\n    sameRankBy: boolean | null;\n    sameComponents: boolean | null;\n    /** Whether the two stored inputs hash identically. */\n    sameInputs: boolean;\n    /** Each section is `null` where the kind has no such content. */\n    membership: MembershipSection | null;\n    rankMoves: RankMovesSection | null;\n    scoreDeltas: ScoreDeltasSection | null;\n    exclusionReasons: CountDelta[] | null;\n    coefficients: NamedDelta[] | null;\n    averageAbnormalReturns: AbnormalReturnDelta[] | null;\n    quantiles: KeyedDelta<number>[] | null;\n    horizons: KeyedDelta<string>[] | null;\n    portfolios: PortfolioMembership[] | null;\n    hygieneVerdict: HygieneVerdictSection | null;\n    /** The structural diff of the two verbatim runs through the parity walk. */\n    run: {\n        differenceCount: number;\n        retainedDifferences: number;\n        addedPaths: string[];\n        removedPaths: string[];\n        truncated: boolean;\n    };\n    assumptions: {\n        conventionsVersion: string;\n        kind: Kind;\n        limits: {\n            maximumDifferences: number;\n            maximumLeaves: number;\n            listedIds: number;\n        };\n    };\n    diagnostics: {\n        warnings: QuantWarning[];\n    };\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"artifactIds","type":"{ baseline: string | null; candidate: string | null; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifactIds.baseline","type":"string | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"artifactIds.candidate","type":"string | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions","type":"{ conventionsVersion: string; kind: Kind; limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.limits","type":"{ listedIds: number; maximumDifferences: number; maximumLeaves: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.limits.listedIds","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.limits.maximumDifferences","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.limits.maximumLeaves","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"averageAbnormalReturns","type":"AbnormalReturnDelta[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"coefficients","type":"NamedDelta[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"exclusionReasons","type":"CountDelta[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"horizons","type":"KeyedDelta<string>[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygieneVerdict","type":"HygieneVerdictSection | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygieneVerdict.baseline","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygieneVerdict.candidate","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygieneVerdict.changed","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership","type":"MembershipSection | null","description":"Each section is `null` where the kind has no such content.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.entered","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.entered.count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.entered.ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.entered.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"membership.exited","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.exited.count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.exited.ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.exited.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"membership.kept","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.kept.count","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.kept.ids","type":"string[]","description":"Listed up to `limits.listedIds`; the remainder is counted.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"membership.kept.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"portfolios","type":"PortfolioMembership[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantiles","type":"KeyedDelta<number>[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rankMoves","type":"RankMovesSection | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rankMoves.movedCount","type":"number","description":"Instruments ranked on both sides whose rank changed.","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"rankMoves.movers","type":"RankMove[]","description":"The largest movers by |delta|, listed up to `limits.listedIds`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rankMoves.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"run","type":"{ addedPaths: string[]; differenceCount: number; removedPaths: string[]; retainedDifferences: number; truncated: boolean; }","description":"The structural diff of the two verbatim runs through the parity walk.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"run.addedPaths","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"run.differenceCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"run.removedPaths","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"run.retainedDifferences","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"run.truncated","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"sameAsOf","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"sameComponents","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"sameFilter","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"sameInputs","type":"boolean","description":"Whether the two stored inputs hash identically.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"sameRankBy","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"sameUniverse","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"scoreDeltas","type":"ScoreDeltasSection | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"scoreDeltas.count","type":"number","description":"Instruments scored on both sides.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"scoreDeltas.maximumAbsoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"scoreDeltas.meanAbsoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"scoreDeltas.perInstrument","type":"ValueDelta[]","description":"Per instrument by |delta| descending, listed up to `limits.listedIds`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"scoreDeltas.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunCostClass","name":"ResearchRunCostClass","kind":"type","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunCostClass","signature":"export type ResearchRunCostClass = 'scan' | 'sort' | 'statistic' | 'event-alignment' | 'aggregation';","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunInputs","name":"ResearchRunInputs","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunInputs","signature":"export interface ResearchRunInputs {\n    screen: ScreenUniverseInput;\n    rank: RankUniverseInput;\n    score: ScoreUniverseInput;\n    'event-study': EventStudyInput;\n    'aggregate-event-studies': AggregateEventStudiesInput;\n    'information-coefficient': InformationCoefficientInput;\n    'factor-spread-return': FactorSpreadReturnInput;\n    'factor-turnover': FactorTurnoverInput;\n    'factor-decay': FactorDecayInput;\n    'quantile-portfolios': FormQuantilePortfoliosInput;\n    'composite-factor-score': CompositeFactorScoreInput;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"aggregate-event-studies","type":"AggregateEventStudiesInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.studies","type":"readonly EventStudyResult[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score","type":"CompositeFactorScoreInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score.components","type":"readonly import('@insiderfinance/totalfinance/research').CompositeComponent[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score.missingValuePolicy","type":"'exclude' | 'renormalize-weights'","description":"`'exclude'` drops an instrument missing any component; `'renormalize-weights'` scores what is present.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study","type":"EventStudyInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.cumulativeConvention","type":"import('@insiderfinance/totalfinance/research').CumulativeConvention","description":"Default `'sum'` (classic CAR) — documented and echoed.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.estimationWindow","type":"import('@insiderfinance/totalfinance/research').TradingSessionWindow","description":"REQUIRED by `'mean-adjusted'` and `'market'`; must END strictly BEFORE the event window\nstarts — a model estimated through the event measures the event twice.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.estimationWindow.endTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.estimationWindow.startTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.eventWindow","type":"import('@insiderfinance/totalfinance/research').TradingSessionWindow","description":"Integers, start ≤ end; offset 0 is the event session.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.eventWindow.endTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.eventWindow.startTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.events","type":"readonly import('@insiderfinance/totalfinance/research').MarketEvent[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.expectedReturnModel","type":"import('@insiderfinance/totalfinance/research').ExpectedReturnModelInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.expectedReturnModel.expectedReturn","type":"(context: import('@insiderfinance/totalfinance/research').ExpectedReturnContext) => number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.expectedReturnModel.expectedReturn(context)","type":"import('@insiderfinance/totalfinance/research').ExpectedReturnContext","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.expectedReturnModel.expectedReturn(context).instrumentId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.expectedReturnModel.expectedReturn(context).marketReturn","type":"number","description":"Present when `marketReturns` were supplied and carry this session's date.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.expectedReturnModel.expectedReturn(context).tradingSessionDate","type":"string","description":"","optional":false,"defaultValue":null,"unit":"calendar date (YYYY-MM-DD)"},{"name":"event-study.expectedReturnModel.model","type":"('custom') | ('market') | ('market-adjusted') | ('mean-adjusted')","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.marketReturns","type":"readonly import('@insiderfinance/totalfinance/research').MarketReturnObservation[]","description":"Required by the `'market-adjusted'` and `'market'` models.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.overlappingEventPolicy","type":"import('@insiderfinance/totalfinance/research').OverlappingEventPolicy","description":"REQUIRED, no default — overlap handling changes the statistics, so the caller must choose.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.returnObservations","type":"readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]","description":"Instrument returns per trading session — the sessions ARE these rows' distinct dates.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.sessionPolicy","type":"import('@insiderfinance/totalfinance/research').EventStudySessionPolicy","description":"Default `'next-session'` — documented in the module header and echoed in assumptions.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay","type":"FactorDecayInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay.factorEntries","type":"readonly import('@insiderfinance/totalfinance/research').FactorEntry[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay.horizons","type":"readonly { horizonLabel: string; forwardReturns: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; }[]","description":"Forward returns at increasing horizons, each labeled.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay.minimumCoverageFraction","type":"number","description":"","optional":true,"defaultValue":null,"unit":"decimal fraction / multiple"},{"name":"factor-spread-return","type":"FactorSpreadReturnInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.direction","type":"'ascending' | 'descending'","description":"`'descending'`: portfolio 1 (highest factor) is the LONG leg.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.entries","type":"readonly import('@insiderfinance/totalfinance/research').FactorEntry[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.forwardReturns","type":"readonly import('@insiderfinance/totalfinance/research').FactorEntry[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.quantileCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"factor-turnover","type":"FactorTurnoverInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-turnover.currentPortfolios","type":"{ quantileIndex: number; instrumentIds: string[]; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-turnover.previousPortfolios","type":"{ quantileIndex: number; instrumentIds: string[]; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient","type":"InformationCoefficientInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.factorEntries","type":"readonly import('@insiderfinance/totalfinance/research').FactorEntry[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.forwardReturns","type":"readonly import('@insiderfinance/totalfinance/research').FactorEntry[]","description":"Forward returns over the evaluation horizon, keyed by instrument.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.minimumCoverageFraction","type":"number","description":"","optional":true,"defaultValue":null,"unit":"decimal fraction / multiple"},{"name":"quantile-portfolios","type":"FormQuantilePortfoliosInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.direction","type":"'ascending' | 'descending'","description":"`'descending'`: portfolio 1 holds the HIGHEST values (the conventional long leg).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.entries","type":"readonly import('@insiderfinance/totalfinance/research').FactorEntry[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.quantileCount","type":"number","description":"How many portfolios (e.g. 5 = quintiles).","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"rank","type":"RankUniverseInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.asOf","type":"number","description":"","optional":false,"defaultValue":null,"unit":"an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)"},{"name":"rank.fieldDefinitions","type":"readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.missingValuePolicy","type":"import('@insiderfinance/totalfinance/research').MissingValuePolicy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.observations","type":"readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.rankBy","type":"{ direction: 'ascending' | 'descending'; field: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.rankBy.direction","type":"'ascending' | 'descending'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.rankBy.field","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.tiePolicy","type":"import('@insiderfinance/totalfinance/research').RankTiePolicy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.universeId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score","type":"ScoreUniverseInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.asOf","type":"number","description":"","optional":false,"defaultValue":null,"unit":"an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)"},{"name":"score.components","type":"readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.fieldDefinitions","type":"readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.missingValuePolicy","type":"'exclude' | 'renormalize-weights'","description":"`'exclude'`: a row missing ANY component is dropped with the reason.\n`'renormalize-weights'`: the row scores over its PRESENT components with weights renormalized\n— disclosed per policy, never per row silently.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.observations","type":"readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.universeId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen","type":"ScreenUniverseInput","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.asOf","type":"number","description":"","optional":false,"defaultValue":null,"unit":"an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)"},{"name":"screen.customPredicate","type":"(observation: import('@insiderfinance/totalfinance/research').UniverseObservation) => boolean","description":"The explicit NON-SERIALIZABLE escape hatch: a caller predicate over the observation. Its\npresence is classified in `assumptions.customPredicate` so a stored screen recipe cannot\nsilently claim reproducibility it does not have.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.customPredicate(observation)","type":"import('@insiderfinance/totalfinance/research').UniverseObservation","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.customPredicate(observation).availableTimestampMs","type":"number","description":"","optional":false,"defaultValue":null,"unit":"epoch milliseconds (UTC instant)"},{"name":"screen.customPredicate(observation).fields","type":"Record<string, import('@insiderfinance/totalfinance/research').ObservedValue>","description":"Values for DECLARED fields only; a key with no declaration is a teaching error.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.customPredicate(observation).instrumentId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.fieldDefinitions","type":"readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter","type":"import('@insiderfinance/totalfinance/research').ScreenFilter","description":"The serializable filter. Omitted → every eligible row passes (ordering still applies).","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter.all","type":"readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter.any","type":"readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter.field","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter.from","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter.not","type":"import('@insiderfinance/totalfinance/research').ScreenFilter","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter.operator","type":"('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator)","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter.to","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter.value","type":"(number) | (string | number | boolean)","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.filter.values","type":"readonly (string | number)[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.limit","type":"number","description":"Keep at most this many rows after ordering; a non-negative safe integer. Omit for all rows.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.missingValuePolicy","type":"import('@insiderfinance/totalfinance/research').MissingValuePolicy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.observations","type":"readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.orderBy","type":"readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]","description":"Ordering keys; `instrumentId` ascending is ALWAYS appended as the stable final tie-breaker.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.universeId","type":"string","description":"The universe's identity, echoed — a screen without provenance is a number without a source.","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunKind","name":"ResearchRunKind","kind":"type","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunKind","signature":"export type ResearchRunKind = 'screen' | 'rank' | 'score' | 'event-study' | 'aggregate-event-studies' | 'information-coefficient' | 'factor-spread-return' | 'factor-turnover' | 'factor-decay' | 'quantile-portfolios' | 'composite-factor-score';","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunKindDescriptor","name":"ResearchRunKindDescriptor","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunKindDescriptor","signature":"/** The frozen, data-only description of one run kind — the research twin of `FITTED_MODEL_FAMILIES`. */\nexport interface ResearchRunKindDescriptor {\n    kind: ResearchRunKind;\n    runVersion: number;\n    /** The direct operation the run re-issues on replay. */\n    operation: string;\n    /** Bulk row-set patterns in the input (`[]` spans an array: `horizons[].forwardReturns`). */\n    bulkRowSets: readonly string[];\n    /** Input fields that, when they carry a caller function, make the run non-replayable. */\n    callbackFields: readonly string[];\n    /** Every kind replays from its stored input as long as no callback participated. */\n    replayableWithoutCallbacks: boolean;\n    costClass: ResearchRunCostClass;\n    requiredData: string;\n}","description":"The frozen, data-only description of one run kind — the research twin of `FITTED_MODEL_FAMILIES`.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"bulkRowSets","type":"readonly string[]","description":"Bulk row-set patterns in the input (`[]` spans an array: `horizons[].forwardReturns`).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"callbackFields","type":"readonly string[]","description":"Input fields that, when they carry a caller function, make the run non-replayable.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"costClass","type":"ResearchRunCostClass","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"kind","type":"ResearchRunKind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"operation","type":"string","description":"The direct operation the run re-issues on replay.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"replayableWithoutCallbacks","type":"boolean","description":"Every kind replays from its stored input as long as no callback participated.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"requiredData","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"runVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunReplay","name":"ResearchRunReplay","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunReplay","signature":"export interface ResearchRunReplay<Kind extends ResearchRunKind = ResearchRunKind> {\n    kind: Kind;\n    artifactId: string;\n    recomputed: ResearchRunReport<Kind>;\n    parity: ArtifactReplayParity;\n    assumptions: {\n        conventionsVersion: string;\n        kind: Kind;\n        runVersion: number;\n        operation: string;\n        libraryVersion: {\n            saved: string | null;\n            current: string | null;\n        };\n        referencedRowSets: string[];\n    };\n    diagnostics: {\n        warnings: QuantWarning[];\n    };\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"artifactId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions","type":"{ conventionsVersion: string; kind: Kind; runVersion: number; operation: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.libraryVersion","type":"{ current: string | null; saved: string | null; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.libraryVersion.current","type":"string | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.libraryVersion.saved","type":"string | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.operation","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.referencedRowSets","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.runVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity","type":"ArtifactReplayParity","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.addedPaths","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.assumptions","type":"{ comparison: 'canonical JSON bytes'; conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.assumptions.comparison","type":"'canonical JSON bytes'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.assumptions.limits","type":"{ maximumDifferences: number; maximumLeaves: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.assumptions.limits.maximumDifferences","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.assumptions.limits.maximumLeaves","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.comparedLeafCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"parity.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.differenceCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"parity.differences","type":"import('@insiderfinance/totalfinance/core/artifacts').ValueDifference[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.identical","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.recomputedHash","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.removedPaths","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.savedHash","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"parity.truncated","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed","type":"ResearchRunReport<Kind>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions","type":"{ conventionsVersion: string; kind: Kind; runVersion: number; operation: string; replayable: boolean; nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; projection: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions.embeddedRowLimit","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions.inputPolicy","type":"'embedded' | 'referenced'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions.kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions.nonReplayableField","type":"string | null","description":"The callback field that made the run non-replayable, when one did.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions.operation","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions.projection","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions.replayable","type":"boolean","description":"`false` exactly when a non-serializable callback participated.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.assumptions.runVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.diagnostics","type":"{ embeddedRows: number; referencedRows: number; runWarningCount: number; warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.diagnostics.embeddedRows","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.diagnostics.referencedRows","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.diagnostics.runWarningCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"recomputed.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene","type":"ResearchHygieneBlock | null","description":"Statistical-hygiene results the caller attached, verbatim — computed by @insiderfinance/totalfinance/risk, never here.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneBacktestOverfitting","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.backtestOverfittingProbability","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.combinations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.medianLogit","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.splits","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.backtestOverfitting.trials","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.deflatedSharpe","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneDeflatedSharpe","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.deflatedSharpe.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.deflatedSharpe.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.deflatedSharpe.deflatedSharpe","type":"number | null","description":"`null` when the statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.deflatedSharpe.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.deflatedSharpe.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.deflatedSharpe.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.deflatedSharpe.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.deflatedSharpe.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"recomputed.hygiene.leakage","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneLeakageReport","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.leakage.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.leakage.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.leakage.clean","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.leakage.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.leakage.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.leakage.leaks","type":"{ split: number; overlapCount: number; sample: number[]; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.multipleTesting","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneMultipleTest","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.multipleTesting.adjusted","type":"number[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.multipleTesting.alpha","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.multipleTesting.method","type":"'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.multipleTesting.rejected","type":"boolean[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.parameterSweep","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneParameterSweep","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.parameterSweep.bestSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.parameterSweep.deflatedSharpe","type":"number | null","description":"`null` when the selected statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.parameterSweep.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.parameterSweep.meanSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.parameterSweep.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.parameterSweep.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"recomputed.hygiene.parameterSweep.varianceSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneResearchVerdict","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.assumptions","type":"{ confidence: number; conventionsVersion: string; periodsPerYear: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.assumptions.confidence","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.assumptions.periodsPerYear","type":"number","description":"","optional":false,"defaultValue":null,"unit":"per year (count)"},{"name":"recomputed.hygiene.protocol.deflatedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.inSample","type":"{ annualizedSharpe: number | null; observations: number; sharpe: number | null; }","description":"Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.inSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.inSample.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.inSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.minTrackRecordLength","type":"number","description":"`Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal.","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"recomputed.hygiene.protocol.outOfSample","type":"{ annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.outOfSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.outOfSample.degradation","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.outOfSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.rationale","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.hygiene.protocol.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"recomputed.hygiene.protocol.verdict","type":"'significant' | 'inconclusive' | 'likely-overfit'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.inputs","type":"Referenced<InputOf<Kind>>","description":"The operation's input with bulk rows either embedded or replaced by verified table references.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.recipe","type":"FactorRecipe | null","description":"The versioned recipe the caller says produced the factor, when one did.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.recipe.direction","type":"'higher-is-better' | 'lower-is-better'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.recipe.disclosure","type":"string","description":"The disclosure every canonical recipe carries: a definition, not the definition.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.recipe.features","type":"readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.recipe.lagTradingSessions","type":"number","description":"Sessions between the information date and use — the lookahead guard.","optional":false,"defaultValue":null,"unit":"trading sessions"},{"name":"recomputed.recipe.missingValuePolicy","type":"'exclude' | 'renormalize-weights'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.recipe.neutralization","type":"'none' | 'sector' | 'sector-and-size'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.recipe.recipeName","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.recipe.recipeVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.referencedData","type":"Record<string, TableHandle>","description":"Table references for every bulk row set that was not embedded (Gate B TableHandle).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.run","type":"RunOf<Kind>","description":"The direct operation's result, verbatim.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recomputed.runVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunReport","name":"ResearchRunReport","kind":"type","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunReport","signature":"/** The typed report every verb reads and writes — the artifact's `result`, verbatim. */\nexport type ResearchRunReport<Kind extends ResearchRunKind = ResearchRunKind> = Readonly<Record<string, unknown>> & {\n    kind: Kind;\n    runVersion: number;\n    /** The direct operation's result, verbatim. */\n    run: RunOf<Kind>;\n    /** The operation's input with bulk rows either embedded or replaced by verified table references. */\n    inputs: Referenced<InputOf<Kind>>;\n    /** Table references for every bulk row set that was not embedded (Gate B TableHandle). */\n    referencedData: Record<string, TableHandle>;\n    /** Statistical-hygiene results the caller attached, verbatim — computed by @insiderfinance/totalfinance/risk, never here. */\n    hygiene: ResearchHygieneBlock | null;\n    /** The versioned recipe the caller says produced the factor, when one did. */\n    recipe: FactorRecipe | null;\n    assumptions: {\n        conventionsVersion: string;\n        kind: Kind;\n        runVersion: number;\n        operation: string;\n        /** `false` exactly when a non-serializable callback participated. */\n        replayable: boolean;\n        /** The callback field that made the run non-replayable, when one did. */\n        nonReplayableField: string | null;\n        inputPolicy: 'embedded' | 'referenced';\n        embeddedRowLimit: number;\n        projection: string;\n    };\n    diagnostics: {\n        warnings: QuantWarning[];\n        embeddedRows: number;\n        referencedRows: number;\n        runWarningCount: number;\n    };\n};","description":"The typed report every verb reads and writes — the artifact's `result`, verbatim.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"assumptions","type":"{ conventionsVersion: string; kind: Kind; runVersion: number; operation: string; replayable: boolean; nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; projection: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.embeddedRowLimit","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.inputPolicy","type":"'embedded' | 'referenced'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.nonReplayableField","type":"string | null","description":"The callback field that made the run non-replayable, when one did.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.operation","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.projection","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.replayable","type":"boolean","description":"`false` exactly when a non-serializable callback participated.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"assumptions.runVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics","type":"{ embeddedRows: number; referencedRows: number; runWarningCount: number; warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics.embeddedRows","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics.referencedRows","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"diagnostics.runWarningCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene","type":"ResearchHygieneBlock | null","description":"Statistical-hygiene results the caller attached, verbatim — computed by @insiderfinance/totalfinance/risk, never here.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneBacktestOverfitting","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.backtestOverfittingProbability","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.combinations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.medianLogit","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.splits","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.backtestOverfitting.trials","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneDeflatedSharpe","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.deflatedSharpe","type":"number | null","description":"`null` when the statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.deflatedSharpe.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"hygiene.leakage","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneLeakageReport","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.assumptions","type":"{ [k: string]: unknown; conventionsVersion: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.clean","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.leakage.leaks","type":"{ split: number; overlapCount: number; sample: number[]; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneMultipleTest","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting.adjusted","type":"number[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting.alpha","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting.method","type":"'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.multipleTesting.rejected","type":"boolean[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneParameterSweep","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.bestSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.deflatedSharpe","type":"number | null","description":"`null` when the selected statistics carried no Sharpe (a zero-variance series).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.meanSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.parameterSweep.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"hygiene.parameterSweep.varianceSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol","type":"import('@insiderfinance/totalfinance/research/artifacts').HygieneResearchVerdict","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.assumptions","type":"{ confidence: number; conventionsVersion: string; periodsPerYear: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.assumptions.confidence","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.assumptions.periodsPerYear","type":"number","description":"","optional":false,"defaultValue":null,"unit":"per year (count)"},{"name":"hygiene.protocol.deflatedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.expectedMaxSharpe","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.inSample","type":"{ annualizedSharpe: number | null; observations: number; sharpe: number | null; }","description":"Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.inSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.inSample.observations","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.inSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.minTrackRecordLength","type":"number","description":"`Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal.","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"hygiene.protocol.outOfSample","type":"{ annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.outOfSample.annualizedSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.outOfSample.degradation","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.outOfSample.sharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.probabilisticSharpe","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.rationale","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"hygiene.protocol.trialCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"hygiene.protocol.verdict","type":"'significant' | 'inconclusive' | 'likely-overfit'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"inputs","type":"Referenced<InputOf<Kind>>","description":"The operation's input with bulk rows either embedded or replaced by verified table references.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe","type":"FactorRecipe | null","description":"The versioned recipe the caller says produced the factor, when one did.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.direction","type":"'higher-is-better' | 'lower-is-better'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.disclosure","type":"string","description":"The disclosure every canonical recipe carries: a definition, not the definition.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.features","type":"readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.lagTradingSessions","type":"number","description":"Sessions between the information date and use — the lookahead guard.","optional":false,"defaultValue":null,"unit":"trading sessions"},{"name":"recipe.missingValuePolicy","type":"'exclude' | 'renormalize-weights'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.neutralization","type":"'none' | 'sector' | 'sector-and-size'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.recipeName","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"recipe.recipeVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"referencedData","type":"Record<string, TableHandle>","description":"Table references for every bulk row set that was not embedded (Gate B TableHandle).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"run","type":"RunOf<Kind>","description":"The direct operation's result, verbatim.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"runVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ResearchRunResults","name":"ResearchRunResults","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunResults","signature":"export interface ResearchRunResults {\n    screen: ScreenUniverseResult;\n    rank: RankUniverseResult;\n    score: ScoreUniverseResult;\n    'event-study': EventStudyResult;\n    'aggregate-event-studies': AggregateEventStudiesResult;\n    'information-coefficient': InformationCoefficientResult;\n    'factor-spread-return': FactorSpreadReturnResult;\n    'factor-turnover': FactorTurnoverResult;\n    'factor-decay': FactorDecayResult;\n    'quantile-portfolios': FormQuantilePortfoliosResult;\n    'composite-factor-score': CompositeFactorScoreResult;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"aggregate-event-studies","type":"AggregateEventStudiesResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions","type":"import('@insiderfinance/totalfinance/research').AggregateEventStudiesAssumptions","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.cumulativeConvention","type":"import('@insiderfinance/totalfinance/research').CumulativeConvention","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.estimationWindow","type":"import('@insiderfinance/totalfinance/research').TradingSessionWindow","description":"Present only when every study declared the identical estimation window.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.estimationWindow.endTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.estimationWindow.startTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.eventWindow","type":"import('@insiderfinance/totalfinance/research').TradingSessionWindow","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.eventWindow.endTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.eventWindow.startTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.expectedReturnModel","type":"string","description":"The shared model name, or `'mixed (…)'` naming each model pooled.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.overlappingEventPolicy","type":"import('@insiderfinance/totalfinance/research').OverlappingEventPolicy | 'mixed'","description":"The shared policy, or `'mixed'` when studies differ.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.assumptions.sessionPolicy","type":"import('@insiderfinance/totalfinance/research').EventStudySessionPolicy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.averageAbnormalReturns","type":"AverageAbnormalReturnRow[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.diagnostics","type":"import('@insiderfinance/totalfinance/research').EventStudyDiagnostics","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.diagnostics.contaminatedEventIds","type":"string[]","description":"Populated under `'allow-contaminated'`; empty under `'reject'` (contamination is removed).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.diagnostics.eventsIncluded","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.diagnostics.eventsSupplied","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.diagnostics.excludedEvents","type":"{ eventId: string; reason: string; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.events","type":"import('@insiderfinance/totalfinance/research').EventStudyEventResult[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"aggregate-event-studies.studiesAggregated","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score","type":"CompositeFactorScoreResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score.assumptions","type":"{ components: Array<{ label: string; weight: number; normalizedWeight: number; direction: string; }>; missingValuePolicy: 'exclude' | 'renormalize-weights'; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score.assumptions.components","type":"{ label: string; weight: number; normalizedWeight: number; direction: string; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score.assumptions.missingValuePolicy","type":"'exclude' | 'renormalize-weights'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score.diagnostics","type":"{ exclusionReasons: Record<string, number>; instrumentCount: number; scoredCount: number; warnings: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score.diagnostics.exclusionReasons","type":"Record<string, number>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score.diagnostics.instrumentCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"composite-factor-score.diagnostics.scoredCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"composite-factor-score.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"composite-factor-score.entries","type":"import('@insiderfinance/totalfinance/research').FactorEntry[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study","type":"EventStudyResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions","type":"import('@insiderfinance/totalfinance/research').EventStudyAssumptions","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.cumulativeConvention","type":"import('@insiderfinance/totalfinance/research').CumulativeConvention","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.estimationWindow","type":"import('@insiderfinance/totalfinance/research').TradingSessionWindow","description":"Echoed exactly when supplied.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.estimationWindow.endTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.estimationWindow.startTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.eventWindow","type":"import('@insiderfinance/totalfinance/research').TradingSessionWindow","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.eventWindow.endTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.eventWindow.startTradingSessionOffset","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.expectedReturnModel","type":"string","description":"The model name; a caller function is classified `'custom (non-serializable)'`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.overlappingEventPolicy","type":"import('@insiderfinance/totalfinance/research').OverlappingEventPolicy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.assumptions.sessionPolicy","type":"import('@insiderfinance/totalfinance/research').EventStudySessionPolicy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.averageAbnormalReturns","type":"AverageAbnormalReturnRow[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.diagnostics","type":"import('@insiderfinance/totalfinance/research').EventStudyDiagnostics","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.diagnostics.contaminatedEventIds","type":"string[]","description":"Populated under `'allow-contaminated'`; empty under `'reject'` (contamination is removed).","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.diagnostics.eventsIncluded","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.diagnostics.eventsSupplied","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.diagnostics.excludedEvents","type":"{ eventId: string; reason: string; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"event-study.events","type":"import('@insiderfinance/totalfinance/research').EventStudyEventResult[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay","type":"FactorDecayResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay.assumptions","type":"{ coefficient: 'rank information coefficient per horizon'; minimumCoverageFraction: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay.assumptions.coefficient","type":"'rank information coefficient per horizon'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay.assumptions.minimumCoverageFraction","type":"number","description":"","optional":false,"defaultValue":null,"unit":"decimal fraction / multiple"},{"name":"factor-decay.byHorizon","type":"{ horizonLabel: string; rankInformationCoefficient: number | null; pairedCount: number; reason?: string; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay.diagnostics","type":"{ warnings: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-decay.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return","type":"FactorSpreadReturnResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.assumptions","type":"{ direction: 'ascending' | 'descending'; legWeighting: 'equal weight within each leg'; quantileCount: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.assumptions.direction","type":"'ascending' | 'descending'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.assumptions.legWeighting","type":"'equal weight within each leg'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.assumptions.quantileCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"factor-spread-return.diagnostics","type":"{ longLegCount: number; shortLegCount: number; warnings: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.diagnostics.longLegCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"factor-spread-return.diagnostics.shortLegCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"factor-spread-return.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.longLegMeanReturn","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.reason","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.shortLegMeanReturn","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-spread-return.spreadReturn","type":"number | null","description":"Mean forward return of portfolio 1 minus portfolio N, or null with the reason.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-turnover","type":"FactorTurnoverResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-turnover.assumptions","type":"{ definition: 'fraction of the current portfolio not present in the previous one'; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-turnover.assumptions.definition","type":"'fraction of the current portfolio not present in the previous one'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-turnover.byQuantile","type":"{ quantileIndex: number; turnover: number | null; reason?: string; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-turnover.diagnostics","type":"{ warnings: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"factor-turnover.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient","type":"InformationCoefficientResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.assumptions","type":"{ minimumCoverageFraction: number; pearsonBasis: 'values'; rankBasis: 'average ranks (Spearman)'; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.assumptions.minimumCoverageFraction","type":"number","description":"","optional":false,"defaultValue":null,"unit":"decimal fraction / multiple"},{"name":"information-coefficient.assumptions.pearsonBasis","type":"'values'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.assumptions.rankBasis","type":"'average ranks (Spearman)'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.diagnostics","type":"{ pairedCount: number; warnings: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.diagnostics.pairedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"information-coefficient.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.informationCoefficient","type":"number | null","description":"Pearson correlation of factor values with forward returns, or null with the reason.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.rankInformationCoefficient","type":"number | null","description":"Spearman (rank) correlation, or null with the reason.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"information-coefficient.reason","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios","type":"FormQuantilePortfoliosResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.assumptions","type":"{ direction: 'ascending' | 'descending'; quantileCount: number; sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; tieBreaker: 'instrumentId ascending'; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.assumptions.direction","type":"'ascending' | 'descending'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.assumptions.quantileCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"quantile-portfolios.assumptions.sizing","type":"'as equal as arithmetic allows; earlier portfolios take the remainder'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.assumptions.tieBreaker","type":"'instrumentId ascending'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.diagnostics","type":"{ coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; excludedMissingCount: number; warnings: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.diagnostics.coverage","type":"import('@insiderfinance/totalfinance/research').FactorCoverage","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.diagnostics.coverage.coverageFraction","type":"number","description":"","optional":false,"defaultValue":null,"unit":"decimal fraction / multiple"},{"name":"quantile-portfolios.diagnostics.coverage.entryCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"quantile-portfolios.diagnostics.coverage.valuedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"quantile-portfolios.diagnostics.excludedMissingCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"quantile-portfolios.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"quantile-portfolios.portfolios","type":"{ quantileIndex: number; instrumentIds: string[]; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank","type":"RankUniverseResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.assumptions","type":"{ asOf: import('@insiderfinance/totalfinance/core').EpochMs; finalTieBreaker: 'instrumentId ascending'; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; rankBy: { field: string; direction: 'ascending' | 'descending'; }; tiePolicy: import('@insiderfinance/totalfinance/research').RankTiePolicy; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.assumptions.asOf","type":"number","description":"","optional":false,"defaultValue":null,"unit":"an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)"},{"name":"rank.assumptions.finalTieBreaker","type":"'instrumentId ascending'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.assumptions.missingValuePolicy","type":"import('@insiderfinance/totalfinance/research').MissingValuePolicy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.assumptions.rankBy","type":"{ direction: 'ascending' | 'descending'; field: string; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.assumptions.rankBy.direction","type":"'ascending' | 'descending'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.assumptions.rankBy.field","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.assumptions.tiePolicy","type":"import('@insiderfinance/totalfinance/research').RankTiePolicy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.assumptions.universeId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.assumptions.versionResolution","type":"'latest available at or before asOf per instrument'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.diagnostics","type":"{ eligibleCount: number; excludedCount: number; exclusionReasons: Record<string, number>; rankedCount: number; suppliedCount: number; warnings: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.diagnostics.eligibleCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"rank.diagnostics.excludedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"rank.diagnostics.exclusionReasons","type":"Record<string, number>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.diagnostics.rankedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"rank.diagnostics.suppliedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"rank.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"rank.rows","type":"{ instrumentId: string; value: number; rank: number; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score","type":"ScoreUniverseResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.assumptions","type":"{ asOf: import('@insiderfinance/totalfinance/core').EpochMs; components: Array<import('@insiderfinance/totalfinance/research').ScoreComponent & { normalizedWeight: number; }>; finalTieBreaker: 'instrumentId ascending'; missingValuePolicy: 'exclude' | 'renormalize-weights'; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.assumptions.asOf","type":"number","description":"","optional":false,"defaultValue":null,"unit":"an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)"},{"name":"score.assumptions.components","type":"(import('@insiderfinance/totalfinance/research').ScoreComponent & { normalizedWeight: number; })[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.assumptions.finalTieBreaker","type":"'instrumentId ascending'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.assumptions.missingValuePolicy","type":"'exclude' | 'renormalize-weights'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.assumptions.universeId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.assumptions.versionResolution","type":"'latest available at or before asOf per instrument'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.diagnostics","type":"{ eligibleCount: number; excludedCount: number; exclusionReasons: Record<string, number>; scoredCount: number; suppliedCount: number; warnings: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.diagnostics.eligibleCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"score.diagnostics.excludedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"score.diagnostics.exclusionReasons","type":"Record<string, number>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.diagnostics.scoredCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"score.diagnostics.suppliedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"score.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"score.rows","type":"{ instrumentId: string; score: number; componentsUsed: number; }[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen","type":"ScreenUniverseResult","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.assumptions","type":"{ asOf: import('@insiderfinance/totalfinance/core').EpochMs; customPredicate?: 'non-serializable caller predicate'; finalTieBreaker: 'instrumentId ascending'; limit?: number; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.assumptions.asOf","type":"number","description":"","optional":false,"defaultValue":null,"unit":"an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)"},{"name":"screen.assumptions.customPredicate","type":"'non-serializable caller predicate'","description":"Present exactly when a caller predicate participated.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.assumptions.finalTieBreaker","type":"'instrumentId ascending'","description":"The stable final ordering key, always applied — determinism under input permutation.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.assumptions.limit","type":"number","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.assumptions.missingValuePolicy","type":"import('@insiderfinance/totalfinance/research').MissingValuePolicy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.assumptions.orderBy","type":"readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.assumptions.universeId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.assumptions.versionResolution","type":"'latest available at or before asOf per instrument'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.diagnostics","type":"{ eligibleCount: number; excludedCount: number; exclusionReasons: Record<string, number>; includedCount: number; suppliedCount: number; warnings: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.diagnostics.eligibleCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"screen.diagnostics.excludedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"screen.diagnostics.exclusionReasons","type":"Record<string, number>","description":"Every exclusion, tallied by reason.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.diagnostics.includedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"screen.diagnostics.suppliedCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"screen.diagnostics.warnings","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"screen.rows","type":"import('@insiderfinance/totalfinance/research').ScreenedRow[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#RunOf","name":"RunOf","kind":"type","url":"/reference/totalfinance/research/artifacts/page-2#RunOf","signature":"export type RunOf<K extends ResearchRunKind> = ResearchRunResults[K];","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[]},{"id":"@insiderfinance/totalfinance/research/artifacts#ScoreDeltasSection","name":"ScoreDeltasSection","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ScoreDeltasSection","signature":"export interface ScoreDeltasSection {\n    /** Instruments scored on both sides. */\n    count: number;\n    meanAbsoluteDelta: number | null;\n    maximumAbsoluteDelta: number | null;\n    /** Per instrument by |delta| descending, listed up to `limits.listedIds`. */\n    perInstrument: ValueDelta[];\n    remainderCount: number;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"count","type":"number","description":"Instruments scored on both sides.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"maximumAbsoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"meanAbsoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"perInstrument","type":"ValueDelta[]","description":"Per instrument by |delta| descending, listed up to `limits.listedIds`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#ValueDelta","name":"ValueDelta","kind":"interface","url":"/reference/totalfinance/research/artifacts/page-2#ValueDelta","signature":"export interface ValueDelta {\n    instrumentId: string;\n    baselineValue: number;\n    candidateValue: number;\n    absoluteDelta: number;\n}","description":"","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"absoluteDelta","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"baselineValue","type":"number","description":"","optional":false,"defaultValue":null,"unit":"currency amount (the field or record currency)"},{"name":"candidateValue","type":"number","description":"","optional":false,"defaultValue":null,"unit":"currency amount (the field or record currency)"},{"name":"instrumentId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#compareResearchRuns","name":"compareResearchRuns","kind":"function","url":"/reference/totalfinance/research/artifacts/page-2#compareResearchRuns","signature":"export declare function compareResearchRuns<Kind extends ResearchRunKind>(input: { baseline: ResearchRunReport<Kind> | AnalysisArtifact; candidate: ResearchRunReport<Kind> | AnalysisArtifact; limits?: ComparisonLimits & { listedIds?: number; }; }): ResearchRunComparison<Kind>;","description":"Compare two research runs of one kind: identity (universe, as-of, filter / rank field /\ncomponents), membership, rank moves, score deltas, exclusion-reason deltas, coefficient deltas,\nabnormal-return deltas per session offset, per-quantile and per-horizon deltas, the hygiene\nverdict change, and the structural diff of the two verbatim runs (Decision 6). Baseline and\ncandidate are named, never \"a\" and \"b\"; nothing is a single similarity score.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"(input)","type":"{ baseline: ResearchRunReport<Kind> | AnalysisArtifact; candidate: ResearchRunReport<Kind> | AnalysisArtifact; limits?: ComparisonLimits & { listedIds?: number; }; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline","type":"AnalysisArtifact | ResearchRunReport<Kind>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.artifactType","type":"string","description":"Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.conventionsVersion","type":"string","description":"The library conventions revision the artifact was CREATED under — stamped from core's\n`CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and\nnever caller-set. Covered by the id; validated as a non-empty string on read.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.createdFrom","type":"string[]","description":"Parent artifact ids this one was derived from, oldest first.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.id","type":"string","description":"Content hash of the body (everything but `id` and `provenance`) — stamped at creation.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.inputs","type":"import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.kind","type":"'totalfinance.analysis-artifact'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.producedBy","type":"import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.provenance","type":"Provenance","description":"Data lineage, caller-supplied, outside the id (labels are not identity).","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.result","type":"Record<string, unknown>","description":"The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.schemaVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).baseline.tables","type":"Record<string, TableHandle>","description":"Named large-table references — rows live where storage puts them, identity lives here.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate","type":"AnalysisArtifact | ResearchRunReport<Kind>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.artifactType","type":"string","description":"Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.conventionsVersion","type":"string","description":"The library conventions revision the artifact was CREATED under — stamped from core's\n`CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and\nnever caller-set. Covered by the id; validated as a non-empty string on read.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.createdFrom","type":"string[]","description":"Parent artifact ids this one was derived from, oldest first.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.id","type":"string","description":"Content hash of the body (everything but `id` and `provenance`) — stamped at creation.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.inputs","type":"import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.kind","type":"'totalfinance.analysis-artifact'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.producedBy","type":"import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.provenance","type":"Provenance","description":"Data lineage, caller-supplied, outside the id (labels are not identity).","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.result","type":"Record<string, unknown>","description":"The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.schemaVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).candidate.tables","type":"Record<string, TableHandle>","description":"Named large-table references — rows live where storage puts them, identity lives here.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).limits","type":"ComparisonLimits & { listedIds?: number; }","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).limits.listedIds","type":"number","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).limits.maximumDifferences","type":"number","description":"Changed, added and removed differences share one retention cap per walk (default 1,000, maximum 100,000); the rest are counted.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).limits.maximumLeaves","type":"number","description":"Canonical work units each side may cost before the comparison refuses (default and maximum\n2,000,000). A leaf costs one unit, so this bounds the leaves walked from above.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"return.artifactIds","type":"{ baseline: string | null; candidate: string | null; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.artifactIds.baseline","type":"string | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.artifactIds.candidate","type":"string | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions","type":"{ conventionsVersion: string; kind: Kind; limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.limits","type":"{ maximumDifferences: number; maximumLeaves: number; listedIds: number; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.limits.listedIds","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.limits.maximumDifferences","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.limits.maximumLeaves","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.averageAbnormalReturns","type":"AbnormalReturnDelta[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.coefficients","type":"NamedDelta[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.exclusionReasons","type":"CountDelta[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.horizons","type":"KeyedDelta<string>[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.hygieneVerdict","type":"HygieneVerdictSection | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.hygieneVerdict.baseline","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.hygieneVerdict.candidate","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.hygieneVerdict.changed","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.membership","type":"MembershipSection | null","description":"Each section is `null` where the kind has no such content.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.membership.entered","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.membership.exited","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.membership.kept","type":"IdListSection","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.portfolios","type":"PortfolioMembership[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.quantiles","type":"KeyedDelta<number>[] | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.rankMoves","type":"RankMovesSection | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.rankMoves.movedCount","type":"number","description":"Instruments ranked on both sides whose rank changed.","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"return.rankMoves.movers","type":"RankMove[]","description":"The largest movers by |delta|, listed up to `limits.listedIds`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.rankMoves.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"return.run","type":"{ differenceCount: number; retainedDifferences: number; addedPaths: string[]; removedPaths: string[]; truncated: boolean; }","description":"The structural diff of the two verbatim runs through the parity walk.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.run.addedPaths","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.run.differenceCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"},{"name":"return.run.removedPaths","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.run.retainedDifferences","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.run.truncated","type":"boolean","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.sameAsOf","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.sameComponents","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.sameFilter","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.sameInputs","type":"boolean","description":"Whether the two stored inputs hash identically.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.sameRankBy","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.sameUniverse","type":"boolean | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.scoreDeltas","type":"ScoreDeltasSection | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.scoreDeltas.count","type":"number","description":"Instruments scored on both sides.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.scoreDeltas.maximumAbsoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.scoreDeltas.meanAbsoluteDelta","type":"number | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.scoreDeltas.perInstrument","type":"ValueDelta[]","description":"Per instrument by |delta| descending, listed up to `limits.listedIds`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.scoreDeltas.remainderCount","type":"number","description":"","optional":false,"defaultValue":null,"unit":"count (integer)"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#readResearchRun","name":"readResearchRun","kind":"function","url":"/reference/totalfinance/research/artifacts/page-2#readResearchRun","signature":"export declare function readResearchRun(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; }): ReadResearchRunResult;","description":"Restore a research-run artifact: Gate B's read door, a foreign-type refusal, then the caller's\nregistry applied a second time at the run level under `research.run:<kind>` (Decision 5), then\nthe report re-validated.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"(input)","type":"{ artifact: unknown; migrations?: ArtifactMigrationRegistry; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).artifact","type":"unknown","description":"The artifact as held OR as restored from JSON (`fromCanonicalJson`) — validated at runtime, never trusted by declaration.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).migrations","type":"ArtifactMigrationRegistry","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"return.artifact","type":"AnalysisArtifact","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.migrationsApplied","type":"AppliedMigration[]","description":"Envelope-level migrations applied by the Gate B read door.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.modelMigrationsApplied","type":"AppliedMigration[]","description":"Report-level (run-version) migrations applied under `research.run:<kind>` — the same echo shape as the fitted-model read doors.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.report","type":"ResearchRunReport<ResearchRunKind>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#replayResearchRun","name":"replayResearchRun","kind":"function","url":"/reference/totalfinance/research/artifacts/page-2#replayResearchRun","signature":"export declare function replayResearchRun(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record<string, unknown[]>; libraryVersion?: string; limits?: ComparisonLimits; }): ResearchRunReplay;","description":"Re-issue the run's direct operation from the stored input and compare canonical bytes with the\nsaved run (Decision 7). Referenced row sets must be supplied and re-verify by hash; a run that\nrecorded a caller callback refuses by name.","examples":[],"tags":[],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"(input)","type":"{ artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record<string, unknown[]>; libraryVersion?: string; limits?: ComparisonLimits; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).artifact","type":"unknown","description":"The artifact as held OR as restored from JSON (`fromCanonicalJson`) — validated at runtime, never trusted by declaration.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).libraryVersion","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).limits","type":"ComparisonLimits","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).migrations","type":"ArtifactMigrationRegistry","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).referencedData","type":"Record<string, unknown[]>","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"return.artifactId","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions","type":"{ conventionsVersion: string; kind: ResearchRunKind; runVersion: number; operation: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.conventionsVersion","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.kind","type":"ResearchRunKind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.libraryVersion","type":"{ saved: string | null; current: string | null; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.libraryVersion.current","type":"string | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.libraryVersion.saved","type":"string | null","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.operation","type":"string","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.referencedRowSets","type":"string[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.assumptions.runVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.diagnostics","type":"{ warnings: QuantWarning[]; }","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.diagnostics.warnings","type":"QuantWarning[]","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.kind","type":"ResearchRunKind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.parity","type":"ArtifactReplayParity","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.recomputed","type":"ResearchRunReport<ResearchRunKind>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"}]},{"id":"@insiderfinance/totalfinance/research/artifacts#researchRunArtifact","name":"researchRunArtifact","kind":"function","url":"/reference/totalfinance/research/artifacts/page-2#researchRunArtifact","signature":"export declare function researchRunArtifact<Kind extends ResearchRunKind>(input: ResearchRunArtifactInput<Kind>): AnalysisArtifact;","description":"Describe a direct research operation's result and save it as an identified, immutable artifact.","examples":["```ts\nconst run = screenUniverse(input);\nconst artifact = researchRunArtifact({ kind: 'screen', run, input, referenceRowSets: ['observations'] });\n```"],"tags":[{"name":"example","text":"```ts\nconst run = screenUniverse(input);\nconst artifact = researchRunArtifact({ kind: 'screen', run, input, referenceRowSets: ['observations'] });\n```"}],"stability":"stable-by-law (pre-1.0; not a 1.0 stability guarantee)","members":[{"name":"(input)","type":"ResearchRunArtifactInput<Kind>","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).createdFrom","type":"string[]","description":"Parent artifact ids (a transform, a prior study, a portfolio set) so lineage is walkable.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).hygiene","type":"ResearchHygieneBlock","description":"Up to six verbatim @insiderfinance/totalfinance/risk results — validated structurally, stored verbatim, never recomputed.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).input","type":"InputOf<Kind>","description":"The operation's input as it was called — rows included; a caller function is recorded and not stored.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).kind","type":"Kind","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).libraryVersion","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).limits","type":"ResearchRunArtifactLimits","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).locators","type":"Record<string, string>","description":"Storage locators to stamp on the minted handles, keyed by row-set label.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).provenance","type":"Provenance","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).recipe","type":"FactorRecipe","description":"The versioned factor recipe that produced the factor, stored verbatim (covered by the artifact id).","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).referenceRowSets","type":"readonly string[]","description":"Concrete row-set labels (`observations`, `horizons[0].forwardReturns`) to store by `TableHandle` instead of embedding.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).run","type":"RunOf<Kind>","description":"The direct operation's result, verbatim.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"(input).snapshotHash","type":"string","description":"","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"return.artifactType","type":"string","description":"Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.conventionsVersion","type":"string","description":"The library conventions revision the artifact was CREATED under — stamped from core's\n`CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and\nnever caller-set. Covered by the id; validated as a non-empty string on read.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.createdFrom","type":"string[]","description":"Parent artifact ids this one was derived from, oldest first.","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"return.id","type":"string","description":"Content hash of the body (everything but `id` and `provenance`) — stamped at creation.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.inputs","type":"import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.kind","type":"'totalfinance.analysis-artifact'","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.producedBy","type":"import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.provenance","type":"Provenance","description":"Data lineage, caller-supplied, outside the id (labels are not identity).","optional":true,"defaultValue":null,"unit":"unitless by name"},{"name":"return.result","type":"Record<string, unknown>","description":"The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`.","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.schemaVersion","type":"number","description":"","optional":false,"defaultValue":null,"unit":"unitless by name"},{"name":"return.tables","type":"Record<string, TableHandle>","description":"Named large-table references — rows live where storage puts them, identity lives here.","optional":true,"defaultValue":null,"unit":"unitless by name"}]}]}