unit_run.components#

Module Contents#

Classes#

Base

Meta

ParameterGroup

Unit

API#

class unit_run.components.Base[source]#

Bases: abc.ABC

PATH_TYPE#

None

classmethod check_data(data)[source]#
validate_data(*args, **kwargs)[source]#
check()[source]#
property valid#
classmethod _check_file_name(file_name)[source]#
classmethod _check_path_to_load(load_path)[source]#
classmethod _check_before_load(load_path)[source]#
classmethod _load_raw_data(load_path)[source]#
classmethod _check_after_load(raw_data)[source]#
classmethod is_path_loadable(load_path)[source]#
classmethod _create_obj_by_raw_data(raw_data)[source]#
_update(other_obj)[source]#
classmethod load_from_disk(load_path)[source]#
classmethod valid_path_exists(path)[source]#
_check_before_save(save_path)[source]#
abstract _save(save_path)[source]#
_after_save(save_path)[source]#
classmethod _exist_handler(path)[source]#
save_to_disk(save_path, all_overwrite=True)[source]#
to_dict()[source]#
to_info_dict()[source]#
__str__() → str[source]#
class unit_run.components.Meta(src_path: str, src_name: str)[source]#

Bases: unit_run.components.Base

FILE_NAME#

‘.meta.json’

PATH_TYPE#

None

classmethod check_data(*param, **kwargs)[source]#
classmethod get_path_by_dir(meta_dir)[source]#
classmethod property(func)[source]#
classmethod _check_file_name(file_name)[source]#
classmethod _load_raw_data(load_path)[source]#
classmethod _check_after_load(raw_data)[source]#
classmethod _create_obj_by_raw_data(raw_data)[source]#
_save(save_path)[source]#
class unit_run.components.ParameterGroup(data)[source]#

Bases: unit_run.components.Base

FILE_SUFFIX#

‘.param_group.json’

PATH_TYPE#

None

classmethod check_data(data)[source]#
check()[source]#
classmethod get_file_name(name)[source]#
classmethod get_path_by_dir_and_name(dir_path, name)[source]#
classmethod get_name_from_path(path)[source]#
classmethod _check_file_name(file_name)[source]#
classmethod _load_raw_data(load_path)[source]#
classmethod load_by_dir_and_name(dir_path, name)[source]#
_save(save_path)[source]#
save_by_dir_and_name(dir_path, name)[source]#
class unit_run.components.Unit(src_path, src_name)[source]#

Bases: unit_run.components.Base

PATH_TYPE#

None

src_path()#
src_name()#
classmethod check_data(unit)[source]#
check_src_obj()[source]#
property src_obj_valid#
property src_obj#
classmethod _check_path_to_load(load_path)[source]#
classmethod _check_after_load(raw_data)[source]#
classmethod get_param_group_pairs_from_dir(dir_path)[source]#
classmethod _load_raw_data(load_dir)[source]#
classmethod _create_obj_by_raw_data(raw_data)[source]#
_check_before_save(save_path)[source]#
_save(save_dir)[source]#
set_param_group(name, group, with_check=True)[source]#
set_param_group_from_disk(path, new_name=None)[source]#
rename_param_group(old_name, new_name, overwrite=False)[source]#
run(group_name)[source]#
_get_param_group_map_dict()[source]#
to_info_dict()[source]#

The information dict for the source unit object

Example:

    print(unit)

{
    "meta": {
        "src_path": "test.py",
        "src_name": "y",
        "load_path": null
    },
    "meta_valid": true,
    "src_valid": false,
    "src_obj_info": null,
    "param_group_map": {
        "name1": {
            "data": [1, 2],
            "load_path": "test/name1.param_group.json",
            "valid": true
        },
        "name2": {
            "data": [10, 1],
            "load_path": "test/name3.param_group.json",
            "valid": true
        }
    }
}
property src_obj_info#
__contains__(group_name)[source]#

Whether group_name in param_group_map of Unit

Parameters:

group_name – Target parameter group name

Returns:

Whether group_name in param_group_map of Unit

Example:
    unit = Unit(src_path, src_name)
    print('name1' in unit)