Skip to content

StudyResult


dataclass backtide.backtest.study.StudyResult[source]

Return the persisted result of a study.

Attributes

study_id : str

Identifier of the persisted study that owns its candidate experiments.

name : str
Study name inherited from the experiment configuration.

strategy_name : str
Saved or runtime strategy used to generate candidates.

objective : str
Main experiment metric used to rank eligible candidates.

maximize : bool
Whether larger objective values rank first.

parameter_space : dict[str, list[object]]
Ordered values evaluated for every swept constructor parameter.

candidates : list[CandidateResult]
Full-sample candidate summaries.

folds : list[WalkForwardFoldResult]
Walk-forward summaries. Empty when validation was not requested.

best_candidate_id : str | None
Highest-ranked eligible full-sample candidate.

min_trades : int
Minimum completed trades required for eligibility.

max_drawdown : float | None
Maximum permitted drawdown magnitude as a positive fraction.

warnings : list[str]
Non-fatal study and engine warnings.

walk_forward : WalkForwardConfig | None
Validation settings used by the study, when enabled.


See Also

CandidateResult

Summarize one parameter combination in a study.

query_study

Return a persisted study.

Study

Run a study with a parameter sweep and optional walk-forward validation.