Skip to main content

CappedSelectionCostScenario

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.

Candidates for one fixed task, an exact checker, and a cap on candidates.

Notes

Equation: The result property composes mlsysim.solvers.CappedSelectionCostModel.solve with the stored fields and any derived properties described below.

Assumptions: Inputs use the units and validity ranges of mlsysim.solvers.CappedSelectionCostModel.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.CappedSelectionCostModel.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.CappedCandidateSelection
>>> round(float(scenario.result.availability), 4)
0.784

Attributes

Name Description
cap
check_cost
generation_cost
pass_rate
result Return the modeled CappedSelectionCost result from

pass_rate

Type: float.

Declared default: required.

cap

Type: int.

Declared default: required.

generation_cost

Type: Quantity.

Declared default: required.

check_cost

Type: Quantity.

Declared default: required.

result

engine.scenario_types.CappedSelectionCostScenario.result

Return the modeled CappedSelectionCost result from mlsysim.solvers.CappedSelectionCostModel.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.

Back to top