mlonmcu.session package

Subpackages

• mlonmcu.session.postprocess package
  • Submodules
  • mlonmcu.session.postprocess.postprocess module
    • Postprocess
      • Postprocess.DEFAULTS
      • Postprocess.FEATURES
      • Postprocess.OPTIONAL
      • Postprocess.REQUIRED
      • Postprocess.process_features()
    • RunPostprocess
      • RunPostprocess.post_run()
    • SessionPostprocess
      • SessionPostprocess.post_session()
  • mlonmcu.session.postprocess.postprocesses module
    • AnalyseCoreVCountsPostprocess
      • AnalyseCoreVCountsPostprocess.DEFAULTS
      • AnalyseCoreVCountsPostprocess.post_run()
      • AnalyseCoreVCountsPostprocess.to_df
      • AnalyseCoreVCountsPostprocess.to_file
    • AnalyseDumpPostprocess
      • AnalyseDumpPostprocess.DEFAULTS
      • AnalyseDumpPostprocess.post_run()
      • AnalyseDumpPostprocess.to_df
      • AnalyseDumpPostprocess.to_file
    • AnalyseInstructionsPostprocess
      • AnalyseInstructionsPostprocess.DEFAULTS
      • AnalyseInstructionsPostprocess.corev
      • AnalyseInstructionsPostprocess.groups
      • AnalyseInstructionsPostprocess.post_run()
      • AnalyseInstructionsPostprocess.seq_depth
      • AnalyseInstructionsPostprocess.sequences
      • AnalyseInstructionsPostprocess.to_df
      • AnalyseInstructionsPostprocess.to_file
      • AnalyseInstructionsPostprocess.top
    • Artifact2ColumnPostprocess
      • Artifact2ColumnPostprocess.DEFAULTS
      • Artifact2ColumnPostprocess.file2colname
      • Artifact2ColumnPostprocess.post_run()
    • Bytes2kBPostprocess
      • Bytes2kBPostprocess.post_session()
    • CompareRowsPostprocess
      • CompareRowsPostprocess.DEFAULTS
      • CompareRowsPostprocess.baseline
      • CompareRowsPostprocess.group_by
      • CompareRowsPostprocess.invert
      • CompareRowsPostprocess.percent
      • CompareRowsPostprocess.post_session()
      • CompareRowsPostprocess.substract
      • CompareRowsPostprocess.to_compare
    • Config2ColumnsPostprocess
      • Config2ColumnsPostprocess.DEFAULTS
      • Config2ColumnsPostprocess.drop
      • Config2ColumnsPostprocess.limit
      • Config2ColumnsPostprocess.post_session()
    • Features2ColumnsPostprocess
      • Features2ColumnsPostprocess.DEFAULTS
      • Features2ColumnsPostprocess.drop
      • Features2ColumnsPostprocess.limit
      • Features2ColumnsPostprocess.post_session()
    • FilterColumnsPostprocess
      • FilterColumnsPostprocess.DEFAULTS
      • FilterColumnsPostprocess.drop
      • FilterColumnsPostprocess.drop_const
      • FilterColumnsPostprocess.drop_empty
      • FilterColumnsPostprocess.drop_nan
      • FilterColumnsPostprocess.keep
      • FilterColumnsPostprocess.post_session()
    • MyPostprocess
      • MyPostprocess.DEFAULTS
      • MyPostprocess.post_session()
    • PassConfig2ColumnsPostprocess
      • PassConfig2ColumnsPostprocess.post_session()
    • RenameColumnsPostprocess
      • RenameColumnsPostprocess.DEFAULTS
      • RenameColumnsPostprocess.mapping
      • RenameColumnsPostprocess.merge
      • RenameColumnsPostprocess.post_session()
    • VisualizePostprocess
      • VisualizePostprocess.DEFAULTS
      • VisualizePostprocess.format
      • VisualizePostprocess.post_session()
    • match_rows()
  • Module contents

Submodules

mlonmcu.session.run module

Definition of a MLonMCU Run which represents a single benchmark instance for a given set of options.

class mlonmcu.session.run.Run(idx=None, model=None, framework=None, frontends=None, backend=None, target=None, platforms=None, features=None, config=None, postprocesses=None, archived=False, session=None, comment='')

Bases: object

A run is single model/backend/framework/target combination with a given set of features and configs.

DEFAULTS = {'export_optional': False, 'stage_subdirs': False, 'target_optimized_layouts': False, 'target_optimized_schedules': False, 'target_to_backend': True, 'tune_enabled': False}

FEATURES = {'autotune', 'target_optimized'}

OPTIONAL = {}

REQUIRED = {}

add_backend(backend)

Setter for the backend instance.

add_backend_by_name(backend_name, context=None)

Helper function to initialize and configure a backend by its name.

add_feature(feature, append=True)

Setter for a feature instance.

add_feature_by_name(feature_name, append=True, context=None)

Helper function to initialize and configure a feature by its name.

add_features(features, append=False)

Setter for the list of features.

add_features_by_name(feature_names, append=False, context=None)

Helper function to initialize and configure features by their names.

add_framework(framework)

Setter for the framework instance.

add_frontend(frontend, append=True)

Setter for the frontend instance.

add_frontend_by_name(frontend_name, context=None)

Helper function to initialize and configure a frontend by its name.

add_frontends(frontends, append=False)

Setter for the list of frontends.

add_frontends_by_name(frontend_names, context=None)

Helper function to initialize and configure frontends by their names.

add_model(model)

Setter for the model instance.

add_model_by_name(model_name, context=None)

Helper function to initialize and configure a model by its name.

add_platform(platform, append=True)

Setter for the platform instance.

add_platform_by_name(platform_name, context=None)

Helper function to initialize and configure a platform by its name.

add_platforms(platforms, append=False)

Setter for the list of platforms.

add_platforms_by_name(platform_names, context=None)

Helper function to initialize and configure platforms by their names.

add_postprocess(postprocess, append=True)

Setter for a postprocess instance.

add_postprocess_by_name(postprocess_name, append=True, context=None)

Helper function to initialize and configure a postprocesses by its name.

add_postprocesses(postprocesses, append=False)

Setter for the list of postprocesses.

add_postprocesses_by_name(postprocess_names, append=False, context=None)

Helper function to initialize and configure postprocesses by their names.

add_target(target)

Setter for the target instance.

add_target_by_name(target_name, context=None)

Helper function to initialize and configure a target by its name.

property artifacts

build()

Process the run using the choosen backend.

property build_platform

Get platform for build stage.

compile()

Compile the target software for the run.

property compile_platform

Get platform for compile stage.

copy()

Create a new run based on this instance.

export(path=None, optional=False)

Write a run configuration to a disk.

property export_optional

Get export_optional property.

export_stage(stage, optional=False)

Export stage artifacts of this run to its directory.

classmethod from_file(path)

Restore a run object which was written to the disk.

property frontend

get_all_configs(omit_paths=False, omit_defaults=False, omit_globals=False)

Return dict with component-specific and global configuration for this run.

get_all_feature_names(only_used=True)

Return list of feature names for this run.

get_all_postprocess_names()

Return list of postprocess names for this run.

get_all_sub_artifacts(sub, stage=None)

get_frontend_name()

Return frontend name(s) for this run.

get_platform_name()

Return platform name(s) for this run.

get_reason_text()

get_report()

Returns teh complete report of this run.

has_stage(stage)

Returns true if the given stage is available for this run.

init_component(component_cls, context=None)

Helper function to create and configure a MLonMCU component instance for this run.

init_directory()

Initialize the temporary directory for this run.

property last_stage

Determines the next not yet completed stage. Returns RunStage.DONE if already completed.

load()

Load the model using the given frontend.

lock()

Aquire a mutex to lock the current run.

property next_stage

Determines the next not yet completed stage. Returns RunStage.DONE if already completed.

postprocess()

Postprocess the ‘run’.

property prefix

Get prefix property.

process(until=RunStage.RUN, skip=None, export=False)

Process the run until a given stage.

process_features(features)

Utility which handles postprocess_features.

run()

Run the ‘run’ using the defined target.

property stage_subdirs

property target_optimized_layouts

Get target_optimized_layouts property.

property target_optimized_schedules

Get target_optimized_schedules property.

property target_platform

Get platform for run stage.

property target_to_backend

Get target_to_backend property.

toDict()

Utility not implemented yet. (TODO: remove?)

tune()

Tune the run using the choosen backend (if supported).

property tune_enabled

Get tune_enabled property.

property tune_platform

Get platform for tune stage.

unlock()

Release a mutex to unlock the current run.

write_run_file()

Create a run.txt file which contains information used to reconstruct the run based on its properties at a later point in time.

class mlonmcu.session.run.RunStage(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Type describing the stages a run can have.

BUILD = 3

COMPILE = 4

DONE = 7

LOAD = 1

NOP = 0

POSTPROCESS = 6

RUN = 5

TUNE = 2

mlonmcu.session.run.add_any(new, base=None, append=True)

mlonmcu.session.session module

Definition of a MLonMCU Run which represents a set of benchmarks in a session.

class mlonmcu.session.session.Session(label='', idx=None, archived=False, dir=None, config=None)

Bases: object

A session which wraps around multiple runs in a context.

DEFAULTS = {'report_fmt': 'csv'}

property active

Get active property.

close(err=None)

Close this run.

create_run(*args, **kwargs)

Factory method to create a run and add it to this session.

discard()

Discard a run and remove its directory.

enumerate_runs()

Update run indices.

property failing

Get failng property.

get_reports()

Returns a full report which includes all runs in this session.

open()

Open this run.

property prefix

get prefix property.

process_runs(until=RunStage.DONE, per_stage=False, print_report=False, num_workers=1, progress=False, export=False, context=None)

Process a runs in this session until a given stage.

property report_fmt

get report_fmt property.

request_run_idx()

Return next free run index.

property runs_dir

update_latest_run_symlink(latest_run_idx)

class mlonmcu.session.session.SessionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Status type for a session.

CLOSED = 2

CREATED = 0

ERROR = 3

OPEN = 1

Module contents