mlonmcu.platform package

Submodules

mlonmcu.platform.espidf module

MLonMCU ESP-IDF platform

class mlonmcu.platform.espidf.EspIdfPlatform(features=None, config=None)

Bases: CompilePlatform, TargetPlatform

ESP-IDF Platform class.

DEFAULTS = {'baud': 115200, 'build_dir': None, 'debug': False, 'flash_only': False, 'num_threads': 2, 'port': None, 'print_outputs': False, 'project_dir': None, 'project_template': None, 'use_idf_monitor': True, 'wait_for_user': True}

FEATURES = {'benchmark', 'debug'}

REQUIRED = {'espidf.install_dir', 'espidf.src_dir'}

property baud

check()

close()

compile(target, src=None)

create_target(name)

property espidf_install_dir

property espidf_src_dir

flash(elf, target, timeout=120)

property flash_only

generate(src, target, model=None)

get_idf_cmake_args()

get_idf_serial_args(monitor=False)

get_supported_targets()

property idf_exe

init_directory(path=None, context=None)

invoke_idf_exe(*args, **kwargs)

monitor(target, timeout=60)

property port

prepare(target, src)

property project_template

property use_idf_monitor

property wait_for_user

mlonmcu.platform.espidf_target module

mlonmcu.platform.lookup module

mlonmcu.platform.lookup.get_platform_names(context)

mlonmcu.platform.lookup.get_platforms_backends(context, config=None)

mlonmcu.platform.lookup.get_platforms_targets(context, config=None)

mlonmcu.platform.lookup.print_backends(platform_backends)

mlonmcu.platform.lookup.print_platforms(platform_names)

mlonmcu.platform.lookup.print_summary(context)

mlonmcu.platform.lookup.print_targets(platform_targets)

mlonmcu.platform.microtvm module

MLonMCU MicroTVM platform

class mlonmcu.platform.microtvm.MicroTvmPlatform(features=None, config=None)

Bases: MicroTvmBasePlatform, MicroTvmCompilePlatform, MicroTvmBuildPlatform, MicroTvmTunePlatform

MicroTVM Platform class.

DEFAULTS = {'aggregate': 'none', 'autoscheduler_enable': False, 'autoscheduler_include_simple_tasks': False, 'autoscheduler_log_estimated_latency': True, 'autotuning_append': None, 'autotuning_early_stopping': None, 'autotuning_max_parallel': 1, 'autotuning_mode': None, 'autotuning_num_workers': None, 'autotuning_results_file': None, 'autotuning_tasks': None, 'autotuning_timeout': 100, 'autotuning_trials': 10, 'autotuning_trials_single': None, 'autotuning_use_rpc': False, 'autotuning_visualize': False, 'autotuning_visualize_file': None, 'autotuning_visualize_live': False, 'autotvm_enable': False, 'autotvm_tuner': 'ga', 'build_dir': None, 'debug': False, 'enable_wandb': False, 'experimental_tvmc_micro_tune': False, 'experimental_tvmc_print_time': False, 'experimental_tvmc_tune_tasks': False, 'experimental_tvmc_tune_visualize': False, 'fill_mode': None, 'ins_file': None, 'metascheduler_enable': False, 'min_repeat_ms': 0, 'num_threads': 2, 'number': 1, 'outs_file': None, 'print_outputs': False, 'print_top': False, 'profile': False, 'project_dir': None, 'project_options': {}, 'project_template': None, 'repeat': 1, 'rpc_hostname': None, 'rpc_key': None, 'rpc_port': None, 'skip_flash': False, 'total_time': False, 'tvmc_custom_script': None, 'use_rpc': False}

FEATURES = {'autoscheduler', 'autotvm', 'benchmark', 'debug', 'metascheduler', 'tvm_profile', 'tvm_rpc'}

REQUIRED = {'tvm.build_dir', 'tvm.configs_dir', 'tvm.pythonpath'}

create_target(name)

get_supported_targets()

mlonmcu.platform.microtvm_backend module

mlonmcu.platform.microtvm_target module

mlonmcu.platform.mlif module

MLonMCU MLIF platform

class mlonmcu.platform.mlif.MlifPlatform(features=None, config=None)

Bases: CompilePlatform, TargetPlatform

Model Library Interface Platform class.

DEFAULTS = {'build_dir': None, 'debug': False, 'debug_symbols': False, 'fail_on_error': False, 'fuse_ld': None, 'garbage_collect': True, 'goal': 'generic_mlonmcu', 'ignore_data': True, 'input_data_path': None, 'lto': False, 'mem_only': False, 'model_support_dir': None, 'num_threads': 2, 'optimize': None, 'output_data_path': None, 'prebuild_lib_path': None, 'print_outputs': False, 'skip_check': False, 'slim_cpp': True, 'strip_strings': False, 'template': 'ml_interface', 'toolchain': 'gcc', 'unroll_loops': None, 'verbose_makefile': False}

FEATURES = {'arm_dsp', 'arm_mvei', 'auto_vectorize', 'benchmark', 'cmsisnn', 'cmsisnnbyoc', 'debug', 'muriscvnn', 'muriscvnnbyoc', 'pext', 'validate', 'vext', 'xpulp'}

OPTIONAL = {'llvm.install_dir', 'srecord.install_dir'}

REQUIRED = {'mlif.src_dir'}

close()

compile(target, src=None, model=None, data_file=None)

configure(target, src, _model)

create_target(name)

property debug_symbols

property fail_on_error

property fuse_ld

property garbage_collect

gen_data_artifact()

generate(src, target, model=None) → Tuple[dict, dict]

get_cmake_args()

get_definitions()

get_supported_targets()

property goal

property ignore_data

init_directory(path=None, context=None)

property input_data_path

property llvm_dir

property lto

property mem_only

property mlif_dir

property model_support_dir

property optimize

property output_data_path

property prebuild_lib_dir

prepare()

prepare_environment()

property skip_check

property slim_cpp

property srecord_dir

property strip_strings

property template

property toolchain

property unroll_loops

property validate_outputs

property verbose_makefile

mlonmcu.platform.mlif_target module

mlonmcu.platform.platform module

class mlonmcu.platform.platform.BuildPlatform(name, features=None, config=None)

Bases: Platform

Abstract build platform class.

export_artifacts(path)

property supports_build

class mlonmcu.platform.platform.CompilePlatform(name, features=None, config=None)

Bases: Platform

Abstract compile platform class.

DEFAULTS = {'build_dir': None, 'debug': False, 'num_threads': 2, 'print_outputs': False}

FEATURES = {'debug'}

property debug

abstract generate(src, target, model=None) → Tuple[dict, dict]

generate_artifacts(src, target, model=None) → List[Artifact]

get_metrics(elf)

property num_threads

property supports_compile

class mlonmcu.platform.platform.Platform(name, features=None, config=None)

Bases: object

Abstract platform class.

DEFAULTS = {'print_outputs': False}

FEATURES = {}

OPTIONAL = {}

REQUIRED = {}

get_supported_backends()

get_supported_targets()

init_directory(path=None, context=None)

property print_outputs

process_features(features)

property supports_build

property supports_compile

property supports_flash

property supports_monitor

property supports_tune

class mlonmcu.platform.platform.TargetPlatform(name, features=None, config=None)

Bases: Platform

Abstract target platform class.

create_target(name)

flash(elf, target, timeout=120)

monitor(target, timeout=60)

run(elf, target, timeout=120)

property supports_flash

property supports_monitor

class mlonmcu.platform.platform.TunePlatform(name, features=None, config=None)

Bases: Platform

Abstract tune platform class.

export_artifacts(path)

property supports_tune

tune_model(model_path, backend, target)

mlonmcu.platform.tvm module

MLonMCU TVM platform

class mlonmcu.platform.tvm.TvmPlatform(features=None, config=None)

Bases: TvmBasePlatform, TvmBuildPlatform, TvmTunePlatform

TVM Platform class.

DEFAULTS = {'aggregate': 'none', 'autoscheduler_enable': False, 'autoscheduler_include_simple_tasks': False, 'autoscheduler_log_estimated_latency': True, 'autotuning_append': None, 'autotuning_early_stopping': None, 'autotuning_max_parallel': 1, 'autotuning_mode': None, 'autotuning_num_workers': None, 'autotuning_results_file': None, 'autotuning_tasks': None, 'autotuning_timeout': 100, 'autotuning_trials': 10, 'autotuning_trials_single': None, 'autotuning_use_rpc': False, 'autotuning_visualize': False, 'autotuning_visualize_file': None, 'autotuning_visualize_live': False, 'autotvm_enable': False, 'autotvm_tuner': 'ga', 'enable_wandb': False, 'experimental_tvmc_tune_tasks': False, 'experimental_tvmc_tune_visualize': False, 'fill_mode': None, 'ins_file': None, 'metascheduler_enable': False, 'min_repeat_ms': 0, 'number': 1, 'outs_file': None, 'print_outputs': False, 'print_top': False, 'profile': False, 'project_dir': None, 'repeat': 1, 'rpc_hostname': None, 'rpc_key': None, 'rpc_port': None, 'total_time': False, 'tvmc_custom_script': None, 'use_rpc': False}

FEATURES = {'autoscheduler', 'autotvm', 'benchmark', 'metascheduler', 'tvm_profile', 'tvm_rpc'}

REQUIRED = {'tvm.build_dir', 'tvm.configs_dir', 'tvm.pythonpath'}

mlonmcu.platform.tvm_backend module

mlonmcu.platform.tvm_target module

mlonmcu.platform.zephyr module

MLonMCU Zephyr platform

class mlonmcu.platform.zephyr.ZephyrPlatform(features=None, config=None)

Bases: CompilePlatform, TargetPlatform

Zephyr Platform class.

DEFAULTS = {'baud': 115200, 'build_dir': None, 'debug': False, 'flash_only': False, 'num_threads': 2, 'optimize': None, 'port': None, 'print_outputs': False, 'project_dir': None, 'project_template': None, 'wait_for_user': True}

FEATURES = {'benchmark', 'debug'}

REQUIRED = {'zephyr.install_dir', 'zephyr.sdk_dir', 'zephyr.venv_dir'}

property baud

property build_dir

close()

compile(target, src=None)

create_target(name)

flash(elf, target, timeout=120)

property flash_only

generate(src, target, model=None) → Tuple[dict, dict]

get_serial(target)

get_supported_targets()

get_west_cmake_args()

init_directory(path=None, context=None)

invoke_west(*args, **kwargs)

monitor(target, timeout=60)

property optimize

property port

prepare(target, src)

property project_template

property wait_for_user

property zephyr_install_dir

property zephyr_sdk_dir

property zephyr_venv_dir

mlonmcu.platform.zephyr_target module

Module contents

MLonMCU platform submodule

class mlonmcu.platform.Platform(name, features=None, config=None)

Bases: object

Abstract platform class.

DEFAULTS = {'print_outputs': False}

FEATURES = {}

OPTIONAL = {}

REQUIRED = {}

get_supported_backends()

get_supported_targets()

init_directory(path=None, context=None)

property print_outputs

process_features(features)

property supports_build

property supports_compile

property supports_flash

property supports_monitor

property supports_tune

mlonmcu.platform.get_platforms()

mlonmcu.platform.register_platform(platform_name, p, override=False)