Skip to content
TotalFinance

Research · @insiderfinance/totalfinance

@insiderfinance/totalfinance/research/artifacts

import { … } from '@insiderfinance/totalfinance/research/artifacts'
stable-by-law (pre-1.0; not a 1.0 stability guarantee)iface 27type 6const 3fn 4JSON ↗

Functions · 4

Values & facades · 3

Interfaces · 27

Types · 6

iface

AbnormalReturnDelta

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { AbnormalReturnDelta } from '@insiderfinance/totalfinance/research/artifacts';

export interface AbnormalReturnDelta {
    tradingSessionOffset: number;
    baselineAverageAbnormalReturn: number | null;
    candidateAverageAbnormalReturn: number | null;
    absoluteDelta: number | null;
    baselineCumulativeAverageAbnormalReturn: number | null;
    candidateCumulativeAverageAbnormalReturn: number | null;
    cumulativeAbsoluteDelta: number | null;
}
Fields, parameters and returned members (7)
Name · typeMeaning · unitRequired · default
absoluteDeltanumber | null—unitless by nameRequiredNo @default declared
baselineAverageAbnormalReturnnumber | null—unitless by nameRequiredNo @default declared
baselineCumulativeAverageAbnormalReturnnumber | null—unitless by nameRequiredNo @default declared
candidateAverageAbnormalReturnnumber | null—unitless by nameRequiredNo @default declared
candidateCumulativeAverageAbnormalReturnnumber | null—unitless by nameRequiredNo @default declared
cumulativeAbsoluteDeltanumber | null—unitless by nameRequiredNo @default declared
tradingSessionOffsetnumber—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

CountDelta

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { CountDelta } from '@insiderfinance/totalfinance/research/artifacts';

export interface CountDelta {
    reason: string;
    baselineCount: number;
    candidateCount: number;
    delta: number;
}
Fields, parameters and returned members (4)
Name · typeMeaning · unitRequired · default
baselineCountnumber—count (integer)RequiredNo @default declared
candidateCountnumber—count (integer)RequiredNo @default declared
deltanumber—unitless by nameRequiredNo @default declared
reasonstring—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

HygieneBacktestOverfitting

#

backtestOverfittingProbability's result — risk's BacktestOverfittingProbabilityResult, structurally.

Signature
import type { HygieneBacktestOverfitting } from '@insiderfinance/totalfinance/research/artifacts';

/** `backtestOverfittingProbability`'s result — risk's `BacktestOverfittingProbabilityResult`, structurally. */
export interface HygieneBacktestOverfitting {
    backtestOverfittingProbability: number;
    combinations: number;
    splits: number;
    observations: number;
    trials: number;
    medianLogit: number;
    assumptions: {
        conventionsVersion: string;
        [k: string]: unknown;
    };
    diagnostics: {
        warnings: QuantWarning[];
    };
}
Fields, parameters and returned members (10)
Name · typeMeaning · unitRequired · default
assumptions{ [k: string]: unknown; conventionsVersion: string; }—unitless by nameRequiredNo @default declared
assumptions.conventionsVersionstring—unitless by nameRequiredNo @default declared
backtestOverfittingProbabilitynumber—unitless by nameRequiredNo @default declared
combinationsnumber—unitless by nameRequiredNo @default declared
diagnostics{ warnings: QuantWarning[]; }—unitless by nameRequiredNo @default declared
diagnostics.warningsQuantWarning[]—unitless by nameRequiredNo @default declared
medianLogitnumber—unitless by nameRequiredNo @default declared
observationsnumber—unitless by nameRequiredNo @default declared
splitsnumber—unitless by nameRequiredNo @default declared
trialsnumber—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

HygieneDeflatedSharpe

#

deflatedSharpeRatio's result — risk's DeflatedSharpeResult, structurally.

Signature
import type { HygieneDeflatedSharpe } from '@insiderfinance/totalfinance/research/artifacts';

/** `deflatedSharpeRatio`'s result — risk's `DeflatedSharpeResult`, structurally. */
export interface HygieneDeflatedSharpe {
    assumptions: {
        conventionsVersion: string;
        [k: string]: unknown;
    };
    diagnostics: {
        warnings: QuantWarning[];
    };
    /** `null` when the statistics carried no Sharpe (a zero-variance series). */
    deflatedSharpe: number | null;
    probabilisticSharpe: number | null;
    expectedMaxSharpe: number;
    trialCount: number;
}
Fields, parameters and returned members (8)
Name · typeMeaning · unitRequired · default
assumptions{ [k: string]: unknown; conventionsVersion: string; }—unitless by nameRequiredNo @default declared
assumptions.conventionsVersionstring—unitless by nameRequiredNo @default declared
deflatedSharpenumber | null

null when the statistics carried no Sharpe (a zero-variance series).

unitless by name
RequiredNo @default declared
diagnostics{ warnings: QuantWarning[]; }—unitless by nameRequiredNo @default declared
diagnostics.warningsQuantWarning[]—unitless by nameRequiredNo @default declared
expectedMaxSharpenumber—unitless by nameRequiredNo @default declared
probabilisticSharpenumber | null—unitless by nameRequiredNo @default declared
trialCountnumber—count (integer)RequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

HygieneLeakageReport

#

detectLeakage's report — risk's LeakageReport, structurally.

Signature
import type { HygieneLeakageReport } from '@insiderfinance/totalfinance/research/artifacts';

/** `detectLeakage`'s report — risk's `LeakageReport`, structurally. */
export interface HygieneLeakageReport {
    assumptions: {
        conventionsVersion: string;
        [k: string]: unknown;
    };
    diagnostics: {
        warnings: QuantWarning[];
    };
    clean: boolean;
    leaks: Array<{
        split: number;
        overlapCount: number;
        sample: number[];
    }>;
}
Fields, parameters and returned members (6)
Name · typeMeaning · unitRequired · default
assumptions{ [k: string]: unknown; conventionsVersion: string; }—unitless by nameRequiredNo @default declared
assumptions.conventionsVersionstring—unitless by nameRequiredNo @default declared
cleanboolean—unitless by nameRequiredNo @default declared
diagnostics{ warnings: QuantWarning[]; }—unitless by nameRequiredNo @default declared
diagnostics.warningsQuantWarning[]—unitless by nameRequiredNo @default declared
leaks{ split: number; overlapCount: number; sample: number[]; }[]—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

HygieneMultipleTest

#

adjustPValues' result — risk's MultipleTestResult, structurally.

Signature
import type { HygieneMultipleTest } from '@insiderfinance/totalfinance/research/artifacts';

/** `adjustPValues`' result — risk's `MultipleTestResult`, structurally. */
export interface HygieneMultipleTest {
    method: 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg';
    alpha: number;
    adjusted: number[];
    rejected: boolean[];
}
Fields, parameters and returned members (4)
Name · typeMeaning · unitRequired · default
adjustednumber[]—unitless by nameRequiredNo @default declared
alphanumber—unitless by nameRequiredNo @default declared
method'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'—unitless by nameRequiredNo @default declared
rejectedboolean[]—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

HygieneParameterSweep

#

parameterSweepDiagnostics' result — risk's ParameterSweepResult, structurally.

Signature
import type { HygieneParameterSweep } from '@insiderfinance/totalfinance/research/artifacts';

/** `parameterSweepDiagnostics`' result — risk's `ParameterSweepResult`, structurally. */
export interface HygieneParameterSweep {
    trialCount: number;
    bestSharpe: number;
    meanSharpe: number;
    varianceSharpe: number;
    expectedMaxSharpe: number;
    /** `null` when the selected statistics carried no Sharpe (a zero-variance series). */
    deflatedSharpe: number | null;
    probabilisticSharpe: number | null;
}
Fields, parameters and returned members (7)
Name · typeMeaning · unitRequired · default
bestSharpenumber—unitless by nameRequiredNo @default declared
deflatedSharpenumber | null

null when the selected statistics carried no Sharpe (a zero-variance series).

unitless by name
RequiredNo @default declared
expectedMaxSharpenumber—unitless by nameRequiredNo @default declared
meanSharpenumber—unitless by nameRequiredNo @default declared
probabilisticSharpenumber | null—unitless by nameRequiredNo @default declared
trialCountnumber—count (integer)RequiredNo @default declared
varianceSharpenumber—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

HygieneResearchVerdict

#

researchProtocol's verdict — risk's ResearchVerdict, structurally.

Signature
import type { HygieneResearchVerdict } from '@insiderfinance/totalfinance/research/artifacts';

/** `researchProtocol`'s verdict — risk's `ResearchVerdict`, structurally. */
export interface HygieneResearchVerdict {
    verdict: 'significant' | 'inconclusive' | 'likely-overfit';
    /** Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`. */
    inSample: {
        sharpe: number | null;
        annualizedSharpe: number | null;
        observations: number;
    };
    deflatedSharpe: number | null;
    probabilisticSharpe: number | null;
    expectedMaxSharpe: number;
    trialCount: number;
    /** `Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal. */
    minTrackRecordLength: number;
    outOfSample?: {
        sharpe: number | null;
        annualizedSharpe: number | null;
        degradation: number | null;
    };
    rationale: string;
    assumptions: {
        conventionsVersion: string;
        confidence: number;
        periodsPerYear: number;
    };
    diagnostics: {
        warnings: QuantWarning[];
    };
}
Fields, parameters and returned members (21)

Loading 21 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

HygieneVerdictSection

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { HygieneVerdictSection } from '@insiderfinance/totalfinance/research/artifacts';

export interface HygieneVerdictSection {
    baseline: string;
    candidate: string;
    changed: boolean;
}
Fields, parameters and returned members (3)
Name · typeMeaning · unitRequired · default
baselinestring—unitless by nameRequiredNo @default declared
candidatestring—unitless by nameRequiredNo @default declared
changedboolean—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

IdListSection

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { IdListSection } from '@insiderfinance/totalfinance/research/artifacts';

export interface IdListSection {
    count: number;
    /** Listed up to `limits.listedIds`; the remainder is counted. */
    ids: string[];
    remainderCount: number;
}
Fields, parameters and returned members (3)
Name · typeMeaning · unitRequired · default
countnumber—unitless by nameRequiredNo @default declared
idsstring[]

Listed up to limits.listedIds; the remainder is counted.

unitless by name
RequiredNo @default declared
remainderCountnumber—count (integer)RequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

type

InputOf

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { InputOf } from '@insiderfinance/totalfinance/research/artifacts';

export type InputOf<K extends ResearchRunKind> = ResearchRunInputs[K];

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

KeyedDelta

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { KeyedDelta } from '@insiderfinance/totalfinance/research/artifacts';

export interface KeyedDelta<Key> {
    key: Key;
    baselineValue: number | null;
    candidateValue: number | null;
    absoluteDelta: number | null;
}
Fields, parameters and returned members (4)
Name · typeMeaning · unitRequired · default
absoluteDeltanumber | null—unitless by nameRequiredNo @default declared
baselineValuenumber | null—currency amount (the field or record currency)RequiredNo @default declared
candidateValuenumber | null—currency amount (the field or record currency)RequiredNo @default declared
keyKey—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

MembershipSection

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { MembershipSection } from '@insiderfinance/totalfinance/research/artifacts';

export interface MembershipSection {
    entered: IdListSection;
    exited: IdListSection;
    kept: IdListSection;
}
Fields, parameters and returned members (12)
Name · typeMeaning · unitRequired · default
enteredIdListSection—unitless by nameRequiredNo @default declared
entered.countnumber—unitless by nameRequiredNo @default declared
entered.idsstring[]

Listed up to limits.listedIds; the remainder is counted.

unitless by name
RequiredNo @default declared
entered.remainderCountnumber—count (integer)RequiredNo @default declared
exitedIdListSection—unitless by nameRequiredNo @default declared
exited.countnumber—unitless by nameRequiredNo @default declared
exited.idsstring[]

Listed up to limits.listedIds; the remainder is counted.

unitless by name
RequiredNo @default declared
exited.remainderCountnumber—count (integer)RequiredNo @default declared
keptIdListSection—unitless by nameRequiredNo @default declared
kept.countnumber—unitless by nameRequiredNo @default declared
kept.idsstring[]

Listed up to limits.listedIds; the remainder is counted.

unitless by name
RequiredNo @default declared
kept.remainderCountnumber—count (integer)RequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

NamedDelta

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { NamedDelta } from '@insiderfinance/totalfinance/research/artifacts';

export interface NamedDelta {
    name: string;
    baselineValue: number | null;
    candidateValue: number | null;
    absoluteDelta: number | null;
}
Fields, parameters and returned members (4)
Name · typeMeaning · unitRequired · default
absoluteDeltanumber | null—unitless by nameRequiredNo @default declared
baselineValuenumber | null—currency amount (the field or record currency)RequiredNo @default declared
candidateValuenumber | null—currency amount (the field or record currency)RequiredNo @default declared
namestring—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

PortfolioMembership

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { PortfolioMembership } from '@insiderfinance/totalfinance/research/artifacts';

export interface PortfolioMembership {
    quantileIndex: number;
    membership: MembershipSection;
}
Fields, parameters and returned members (14)

Loading 14 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

const

RESEARCH_RUN_ARTIFACT_TYPE

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { RESEARCH_RUN_ARTIFACT_TYPE } from '@insiderfinance/totalfinance/research/artifacts';

export declare const RESEARCH_RUN_ARTIFACT_TYPE: 'research.run';

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

const

RESEARCH_RUN_KINDS

#

The frozen descriptor per run kind — Program 5's registry metadata without a registry.

Signature
import { RESEARCH_RUN_KINDS } from '@insiderfinance/totalfinance/research/artifacts';

export declare const RESEARCH_RUN_KINDS: Readonly<Record<ResearchRunKind, ResearchRunKindDescriptor>>;

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

const

RESEARCH_RUN_LIMITS

#

Decision 9's bounded-work table (core's ARTIFACT_WORK_LIMITS, re-exported for this subpath's callers).

Signature
import { RESEARCH_RUN_LIMITS } from '@insiderfinance/totalfinance/research/artifacts';

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; }>; }>;
Fields, parameters and returned members (22)

Loading 22 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

RankMove

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { RankMove } from '@insiderfinance/totalfinance/research/artifacts';

export interface RankMove {
    instrumentId: string;
    baselineRank: number;
    candidateRank: number;
    /** candidate − baseline (positive = moved down the ranking). */
    delta: number;
}
Fields, parameters and returned members (4)
Name · typeMeaning · unitRequired · default
baselineRanknumber—unitless by nameRequiredNo @default declared
candidateRanknumber—unitless by nameRequiredNo @default declared
deltanumber

candidate − baseline (positive = moved down the ranking).

unitless by name
RequiredNo @default declared
instrumentIdstring—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

iface

RankMovesSection

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import type { RankMovesSection } from '@insiderfinance/totalfinance/research/artifacts';

export interface RankMovesSection {
    /** Instruments ranked on both sides whose rank changed. */
    movedCount: number;
    /** The largest movers by |delta|, listed up to `limits.listedIds`. */
    movers: RankMove[];
    remainderCount: number;
}
Fields, parameters and returned members (3)
Name · typeMeaning · unitRequired · default
movedCountnumber

Instruments ranked on both sides whose rank changed.

count (integer)
RequiredNo @default declared
moversRankMove[]

The largest movers by |delta|, listed up to limits.listedIds.

unitless by name
RequiredNo @default declared
remainderCountnumber—count (integer)RequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.