Source code for orion.core.cli.insert

#!/usr/bin/env python
# pylint: disable=eval-used,protected-access
Module to insert new trials

Insert creates new trials for a given experiment with fixed values

import collections
import logging
import os
import re

from orion.core.cli import base as cli
from import experiment_builder
from import infer_converter_from_file_type
from orion.core.utils.format_trials import tuple_to_trial

log = logging.getLogger(__name__)

SHORT_DESCRIPTION = "Inserts new trials in an existing experiment"
DESCRIPTION = "Insert new trials for a given experiment with fixed values"

[docs]def add_subparser(parser): """Add the subparser that needs to be used for this command""" insert_parser = parser.add_parser( "insert", help=SHORT_DESCRIPTION, description=DESCRIPTION ) cli.get_basic_args_group(insert_parser) cli.get_user_args_group(insert_parser) insert_parser.set_defaults(func=main) insert_parser.set_defaults(help_empty=True) # Print help if command is empty return insert_parser
[docs]def main(args): """Fetch config and insert new point""" command_line_user_args = args.pop("user_args", [None])[1:] experiment = experiment_builder.get_from_args(args, mode="w") transformed_args = _build_from(command_line_user_args) exp_space = values = _create_tuple_from_values(transformed_args, exp_space) trial = tuple_to_trial(values, exp_space) experiment.register_trial(trial)
def _validate_dimensions(transformed_args, exp_space): exp_namespaces = list(exp_space.keys()) values = {} # Find any dimension that is not given by the user and make sure they have a default value for exp_n in exp_namespaces: if ( exp_n not in transformed_args.keys() and exp_space[exp_n].default_value is None ): raise ValueError( f"Dimension {exp_n} is unspecified and has no default value" ) # Find any namespace that is not in the space of the experiment, # or values that lie outside the prior's interval for namespace, value in transformed_args.items(): if namespace not in exp_space: raise ValueError( f"Found namespace outside of experiment space : {namespace}" ) valid, value = _validate_input_value(value, exp_space, namespace) if not valid: raise ValueError(f"Value {value} is outside of dimension's prior interval") values[namespace] = value return values def _validate_input_value(value, exp_space, namespace): is_valid = False try: value = eval(value) is_valid = value in exp_space[namespace] except (NameError, SyntaxError): is_valid = value in exp_space[namespace] return is_valid, value def _create_tuple_from_values(transformed_args, exp_space): values_dict = _validate_dimensions(transformed_args, exp_space) values = [] for namespace, dim in exp_space.items(): if namespace in values_dict: values.append(values_dict[namespace]) else: values.append(dim.default_value) return values def _build_from(cmd_args): transformed_args, userconfig, _ = _build_from_args(cmd_args) if userconfig: transformed_args = _build_from_config(userconfig) return transformed_args def _build_from_config(config_path): converter = infer_converter_from_file_type(config_path) userconfig_tmpl = converter.parse(config_path) userconfig_keyword = "orion=" transformed_args = {} stack = collections.deque() stack.append(("", userconfig_tmpl)) while True: try: namespace, stuff = stack.pop() except IndexError: break if isinstance(stuff, dict): for k, v in stuff.items(): stack.append(("/".join([namespace, str(k)]), v)) elif isinstance(stuff, list): for position, thing in enumerate(stuff): stack.append(("/".join([namespace, str(position)]), thing)) elif isinstance(stuff, str): if stuff.startswith(userconfig_keyword): if namespace in transformed_args: raise ValueError( f"Conflict for name '{namespace}' in script configuration and arguments." ) transformed_args[namespace] = stuff[len(userconfig_keyword) :] return transformed_args def _build_from_args(cmd_args): userconfig = None is_userconfig_an_option = None userargs_search = r"\W*([a-zA-Z0-9_-]+)=([^ ]+)" userargs_regex_tmpl = r"(.*)=(.*)" userconfig_option = "--config=" transformed_args = {} userargs_tmpl = collections.defaultdict(list) args_pattern = re.compile(userargs_search) args_prefix_pattern = re.compile(userargs_regex_tmpl) for arg in cmd_args: found = args_pattern.findall(arg) if len(found) != 1: if arg.startswith(userconfig_option): if not userconfig: userconfig = arg[len(userconfig_option) :] is_userconfig_an_option = True else: raise ValueError( f"Already found one configuration file in: {userconfig}" ) else: userargs_tmpl[None].append(arg) continue name, value = found[0] namespace = "/" + name if namespace in transformed_args: raise ValueError( f"Conflict for name '{namespace}' in script configuration and arguments." ) transformed_args[namespace] = value found = args_prefix_pattern.findall(arg) assert len(found) == 1 and found[0][1] == value, "Parsing prefix problem." userargs_tmpl[namespace] = found[0][0] + "=" if not userconfig and userargs_tmpl[None]: # try the first positional argument if os.path.isfile(userargs_tmpl[None][0]): userconfig = userargs_tmpl[None].pop(0) is_userconfig_an_option = False return transformed_args, userconfig, is_userconfig_an_option