composer.profiler.profiler_hparams#

Example usage and definition of hparams.

Hparams

These classes are used with yahp for YAML-based configuration.

`CyclicProfilerScheduleHparams`	Hyperparameters for the `cyclic_schedule()`.
`JSONTraceHparams`	Hyperparameters for the `JSONTraceHandler`.
`ProfileScheduleHparams`	Base class for Composer Profiler schedule hparams.
`TraceHandlerHparams`	Base class for the `TraceHandler` hparams.

Attributes

profiler_scheduler_registry
trace_handler_registory

class composer.profiler.profiler_hparams.CyclicProfilerScheduleHparams(skip_first=0, wait=0, warmup=1, active=4, repeat=1)[source]#

Bases: composer.profiler.profiler_hparams.ProfileScheduleHparams

Hyperparameters for the cyclic_schedule().

Parameters

skip_first (int, optional) – See cyclic_schedule().
wait (str, optional) – See cyclic_schedule().
warmup (str, optional) – See cyclic_schedule().
active (str, optional) – See cyclic_schedule().
repeat (str, optional) – See cyclic_schedule().

class composer.profiler.profiler_hparams.JSONTraceHparams(folder='{run_name}/traces', filename='ep{epoch}-ba{batch}-rank{rank}.json', artifact_name='{run_name}/traces/ep{epoch}-ba{batch}-rank{rank}.json', merged_trace_filename='node{node_rank}.json', merged_trace_artifact_name='{run_name}/traces/merged_trace.json', overwrite=False, num_traces_to_keep=- 1)[source]#

Bases: composer.profiler.profiler_hparams.TraceHandlerHparams

Hyperparameters for the JSONTraceHandler.

Parameters

folder (str, optional) – See JSONTraceHandler.
filename (str, optional) – See JSONTraceHandler.
artifact_name (str, optional) – See JSONTraceHandler.
merged_trace_filename (str, optional) – See JSONTraceHandler.
merged_trace_artifact_name (str, optional) – See JSONTraceHandler.
overwrite (bool, optional) – See JSONTraceHandler.
num_traces_to_keep (int, optional) – See JSONTraceHandler.

class composer.profiler.profiler_hparams.ProfileScheduleHparams[source]#

Bases: yahp.hparams.Hparams, abc.ABC

Base class for Composer Profiler schedule hparams.

abstract initialize_object()[source]#

Constructs and returns a Composer Profiler scheduler.

The scheduler is used prof_schedule argument for the Trainer.

Returns: (state) -> ProfilerAction – The profiler scheduler.

class composer.profiler.profiler_hparams.TraceHandlerHparams[source]#

Bases: yahp.hparams.Hparams, abc.ABC

Base class for the TraceHandler hparams.

abstract initialize_object()[source]#

Constructs and returns an instance of a TraceHandler.

Returns: TraceHandler – The trace handler.

composer.profiler.profiler_hparams.profiler_scheduler_registry = {'cyclic': <class 'composer.profiler.profiler_hparams.CyclicProfilerScheduleHparams'>}#: Profiler scheduler registry.

composer.profiler.profiler_hparams.trace_handler_registory = {'json': <class 'composer.profiler.profiler_hparams.JSONTraceHparams'>}#: Trace handler registry.