Skip to main content

Module evaluation

Module evaluation 

Source
Expand description

Additive, report-independent provider evaluation.

The module accepts normalized PositionOutcome rows instead of depending on crate::report::TradeResult or crate::report::PositionSummary. A current integration can map one PositionSummary to one outcome (net_pnl, symbol, side, group, close reasons, and final-close ordering); future report versions can additionally supply R, excursions, lifecycle counters, and execution diagnostics without changing this evaluator.

Filtering is exact and case-sensitive. Values within a filter dimension are ORed, while different dimensions (including each tag key) are ANDed. Breakdowns and rolling order are deterministic. No overall score, rank, or rating is produced.

Structs§

BootstrapConfig
Configuration for deterministic bootstrap confidence intervals.
BreakdownBucket
BreakdownRowSummary
Visibility into minimum-count filtering and global breakdown row truncation.
ConfidenceInterval
CostMetricsSection
Commission and swap actually charged across the selected positions.
CoverageSection
CumulativeRPoint
One chronologically ordered point on the cumulative realized-R curve.
EvaluationBreakdown
EvaluationContext
Provider and source identifiers attached to an evaluation without changing the normalized position rows.
EvaluationOptions
Typed report configuration, deliberately separate from normalized position and lifecycle inputs.
EvaluationPositionRows
Filtered normalized position rows included for metric reconciliation.
EvaluationReport
Provider-evaluation result. It intentionally has no aggregate score, rank, or rating; consumers decide which individual sections matter for their use case.
EvaluationRequest
Complete input to super::evaluate. options is flattened so payloads produced before EvaluationOptions was introduced retain the same serde shape.
ExcursionInput
R-normalized maximum favorable and adverse excursion values.
ExcursionMetricsSection
ExecutionDiagnosticsInput
Optional per-position execution observations.
ExecutionDiagnosticsSection
IntrinsicRobustnessSection
LifecycleCounts
Aggregate lifecycle counters supplied by a provider integration.
MetricValue
A metric accompanied by an explicit availability status.
PnlConcentrationSection
Shares of gross positive completed-position P&L contributed by the top N winners.
PositionCostsInput
Per-position commission and swap already applied to outcome.
PositionDimensions
Dimensions used for filtering and deterministic breakdowns.
PositionFilter
Typed position filter.
PositionOutcome
Generic completed-position input for provider evaluation.
PositionPerformanceSection
RMetricsSection
RQuantiles
Deterministic type-7 quantiles of finite realized-R observations.
RemovalImpact
RollingOutcome
RollingOutcomes
SourceCoverageCounts
Parser/source coverage supplied by an integration that can observe raw input.

Enums§

BreakdownDimension
A requested categorical breakdown. Duplicate requests are evaluated once.
BreakdownValue
Typed and sortable breakdown key.
EvaluationSection
Independently selectable provider-report sections.
GroupFilter
Selects grouped positions, including positions that have no group.
MetricStatus
Describes whether a metric can be interpreted by a consumer.
OutcomeClassification
Provider-supplied classification of a completed-position outcome.
PositionSide
Normalized position direction, independent of the execution engine’s side type.

Functions§

bootstrap_mean_confidence
Computes a deterministic percentile-bootstrap confidence interval for a mean.
evaluate
Evaluates normalized provider outcomes without coupling to a backtest report.
wilson_interval
Computes a two-sided Wilson score interval for a binomial proportion.