check_warmup

forge.testingfunctionSince Forge API 1
Signaturepython
forge.testing.check_warmup(strategy: str | os.PathLike[str] | type[Strategy],bars: SampleBars | pd.DataFrame | None = None,params: Mapping[str, Any] | None = None,*,symbol: str | None = None,timeframe: str | None = None,facts: Mapping[str, Any] | None = None) -> dict[str, Any]

Measure how much each output of a strategy depends on where its data starts, as plain JSON.

Parameters

NameTypeDefault
strategystr | os.PathLike[str] | type[Strategy]
barsSampleBars | pd.DataFrame | NoneNone
paramsMapping[str, Any] | NoneNone
symbolstr | NoneNone
timeframestr | NoneNone
factsMapping[str, Any] | NoneNone

Every plot, recorded series, declared signal and named condition is computed over the whole history and over histories that start later. A moving average is exact after its window, an exponential average settles after a number of bars the report gives, and a running total never settles. The arguments are those of run.