ProportionPlanningScenario
Statistics scenarios · Implementation: mlsysim/engine/scenario_definitions/statistics.py.
Construct this scenario with keyword inputs. The fields below show the types and defaults declared by this class.
Planning targets for one acceptance rate and for two independent arms.
Notes
Equation: The result property composes mlsysim.solvers.ProportionPlanningModel.solve with the stored fields and any derived properties described below.
Assumptions: Inputs use the units and validity ranges of mlsysim.solvers.ProportionPlanningModel.solve. The named scenario supplies a fixed configuration rather than observations of a new run.
Excludes: Additional runtime effects or statistical guarantees beyond the cited solver contracts; no measurement is performed by this wrapper.
References
Derivation: The result property composes mlsysim.solvers.ProportionPlanningModel.solve with the stored fields and any derived properties described below. Individual property contracts identify the exact accounting expression or reusable calculation. Registry entries supply the scenario inputs; this class does not turn them into measured outcomes.
Examples
Evaluate a named scenario using its declared inputs.
>>> from mlsysim import Scenarios
>>> scenario = Scenarios.AcceptanceRatePlanning
>>> round(float(scenario.result.z_critical), 4)
1.96Attributes
| Name | Description |
|---|---|
| confidence | |
| differences | |
| planning_tasks | |
| power | |
| rate | |
| result | Return the modeled ProportionPlanning result from |
| significance | |
| target_half_width | |
| z_alpha | |
| z_beta |
rate
Type: float.
Declared default: required.
planning_tasks
Type: int.
Declared default: required.
target_half_width
Type: float.
Declared default: required.
differences
Type: List[float].
Declared default: required.
significance
Type: float.
Declared default: required.
power
Type: float.
Declared default: required.
z_alpha
Type: float.
Declared default: required.
z_beta
Type: float.
Declared default: required.
confidence
Type: float.
Declared default: 0.95.
result
engine.scenario_types.ProportionPlanningScenario.result
Return the modeled ProportionPlanning result from mlsysim.solvers.ProportionPlanningModel.solve.
Equation: the scenario supplies its named fields to that solver. Returned quantity units, validity conditions, and omissions follow its calculation contract; this property adds no empirical calibration.