aitune.torch.task.profiling.measuring_stop_strategy

Measuring stop strategies for profiling.

Module Contents

Classes

Name	Description
`MeasuringStopStrategy`	Strategy when to stop collecting measurements for given batch size.
`NumStepsMeasuringStopStrategy`	Strategy to stop collecting measurements after a given number of steps.
`StableWindowMeasuringStopStrategy`	Strategy to stop collecting measurements after a stable sliding window has been collected.

API

class aitune.torch.task.profiling.measuring_stop_strategy.MeasuringStopStrategy()

Abstract

Strategy when to stop collecting measurements for given batch size.

aitune.torch.task.profiling.measuring_stop_strategy.MeasuringStopStrategy.get_events(
    results: list[aitune.torch.task.profiling.events.ProfilingResultEvent]
) -> list[aitune.torch.task.profiling.events.ProfilingResultEvent]

abstract

Get events to use for measuring stop strategy.

aitune.torch.task.profiling.measuring_stop_strategy.MeasuringStopStrategy.should_stop(
    results: list[aitune.torch.task.profiling.events.ProfilingResultEvent]
) -> bool

abstract

Check if the measurement should be stopped.

Parameters:

results

list[ProfilingResultEvent]

List of profiling results events for a one measurement.

Returns: bool

True if the measurement should be stopped, False otherwise.

class aitune.torch.task.profiling.measuring_stop_strategy.NumStepsMeasuringStopStrategy(
    num_steps: int = 20,
    warmup_samples: int = 10
)

Bases: MeasuringStopStrategy

Strategy to stop collecting measurements after a given number of steps.

_min_samples_seen

= self.warmup_samples + self.num_steps

_samples_seen

= 0

aitune.torch.task.profiling.measuring_stop_strategy.NumStepsMeasuringStopStrategy.get_events(
    results: list[aitune.torch.task.profiling.events.ProfilingResultEvent]
) -> list[aitune.torch.task.profiling.events.ProfilingResultEvent]

Get final measured events after should_stop() has returned True.

aitune.torch.task.profiling.measuring_stop_strategy.NumStepsMeasuringStopStrategy.should_stop(
    results: list[aitune.torch.task.profiling.events.ProfilingResultEvent]
) -> bool

Check if the measurement should be stopped.

class aitune.torch.task.profiling.measuring_stop_strategy.StableWindowMeasuringStopStrategy(
    window_size: int = 20,
    max_cv_ratio: float = 0.1,
    warmup_samples: int = 10,
    max_samples: int = 100
)

Bases: MeasuringStopStrategy

Strategy to stop collecting measurements after a stable sliding window has been collected.

_max_samples_seen

= self.max_samples + self.warmup_samples

_min_samples_seen

= self.window_size + self.warmup_samples

_samples_seen

= 0

_window

list[ProfilingResultEvent] = []

aitune.torch.task.profiling.measuring_stop_strategy.StableWindowMeasuringStopStrategy.get_events(
    results: list[aitune.torch.task.profiling.events.ProfilingResultEvent]
) -> list[aitune.torch.task.profiling.events.ProfilingResultEvent]

Get events to use for measuring stop strategy.

aitune.torch.task.profiling.measuring_stop_strategy.StableWindowMeasuringStopStrategy.should_stop(
    results: list[aitune.torch.task.profiling.events.ProfilingResultEvent]
) -> bool

Check if the measurement should be stopped.