Skip to main content

RetrievalPayloadScenario

Agents scenarios · Implementation: mlsysim/engine/scenario_definitions/agents.py.

Construct this scenario with keyword inputs. The fields below show the types and defaults declared by this class.

Whole serialized records staged in what a call’s window leaves for retrieval.

Notes

Equation: Result = mlsysim.solvers.RetrievalPayloadModel.solve with the named scenario fields; no extra fitting or postprocessing is applied.

Assumptions: The supplied inputs use the units and validity regime documented by RetrievalPayloadModel.solve; this class binds one reproducible configuration.

Excludes: Any behavior excluded by RetrievalPayloadModel.solve, and measurement or calibration of the supplied inputs.

References

Implementation reference: mlsysim.solvers.RetrievalPayloadModel.solve documents the composed equation and its sources.

Examples

The named registry scenario supplies the stated inputs; this is a modeled calculation, not a new measurement.

>>> from mlsysim import Scenarios
>>> scenario = Scenarios.RetrievalRecordsInAllowance
>>> scenario.result.allowance
6144

Attributes

Name Description
body
envelope
metadata
metadata_scale
other_input
output_reserve
result Return mlsysim.solvers.RetrievalPayloadModel.solve for this scenario; output fields retain the units and feasibility semantics specified by that solver.
window

window

Type: int.

Declared default: required.

output_reserve

Type: int.

Declared default: required.

other_input

Type: int.

Declared default: required.

envelope

Type: int.

Declared default: required.

body

Type: int.

Declared default: required.

metadata

Type: int.

Declared default: required.

metadata_scale

Type: Optional[int].

Declared default: None.

result

engine.scenario_types.RetrievalPayloadScenario.result

Return mlsysim.solvers.RetrievalPayloadModel.solve for this scenario; output fields retain the units and feasibility semantics specified by that solver.

Equation: mlsysim.solvers.RetrievalPayloadModel.solve (scenario fields).

Back to top