CompressionRunScenario
Communication scenarios · Implementation: mlsysim/engine/scenario_definitions/communication.py.
Construct this scenario with keyword inputs. The fields below show the types and defaults declared by this class.
A run to a quality target with and without gradient compression on several networks.
Notes
Equation: Compose mlsysim.solvers.CompressionRunModel.
Assumptions: The stated fields are inputs to mlsysim.solvers.CompressionRunModel; its documented validity regime, units, and modeling choices apply unchanged.
Excludes: This scenario adds no measurement, empirical calibration, or mechanisms beyond mlsysim.solvers.CompressionRunModel.
References
Derivation: this scenario binds its input fields to the referenced implementation contracts: mlsysim.solvers.CompressionRunModel. The methods below identify any additional arithmetic.
Examples
>>> from mlsysim import Scenarios
>>> case = Scenarios.Int8CompressionRun
>>> type(case.result).__name__
'CompressionRunResult'Attributes
| Name | Description |
|---|---|
| communication_times | |
| compression_ratio | |
| compute_time | |
| result | Evaluate this scenario through mlsysim.solvers.CompressionRunModel.solve. Equation: |
| step_penalty | |
| steps |
steps
Type: int.
Declared default: required.
compute_time
Type: Quantity.
Declared default: required.
communication_times
Type: Dict[str, Quantity].
Declared default: required.
compression_ratio
Type: float.
Declared default: required.
step_penalty
Type: float.
Declared default: required.
result
engine.scenario_types.CompressionRunScenario.result
Evaluate this scenario through mlsysim.solvers.CompressionRunModel.solve. Equation: pass the stated fields to that implementation; its contract defines the calculation and feasibility tests. Units: each returned field follows the referenced result schema; no independent equation is evaluated by this wrapper.