syne_tune.optimizer.schedulers.searchers.utils.default_arguments module

class syne_tune.optimizer.schedulers.searchers.utils.default_arguments.CheckType

Bases: object

assert_valid(key, value)

class syne_tune.optimizer.schedulers.searchers.utils.default_arguments.Float(lower=None, upper=None)

Bases: CheckType

assert_valid(key, value)

class syne_tune.optimizer.schedulers.searchers.utils.default_arguments.Integer(lower=None, upper=None)

Bases: CheckType

assert_valid(key, value)

class syne_tune.optimizer.schedulers.searchers.utils.default_arguments.IntegerOrNone(lower=None, upper=None)

Bases: Integer

assert_valid(key, value)

class syne_tune.optimizer.schedulers.searchers.utils.default_arguments.Categorical(choices)

Bases: CheckType

assert_valid(key, value)

class syne_tune.optimizer.schedulers.searchers.utils.default_arguments.String

Bases: CheckType

assert_valid(key, value)

class syne_tune.optimizer.schedulers.searchers.utils.default_arguments.Boolean

Bases: CheckType

assert_valid(key, value)

class syne_tune.optimizer.schedulers.searchers.utils.default_arguments.Dictionary

Bases: CheckType

assert_valid(key, value)

syne_tune.optimizer.schedulers.searchers.utils.default_arguments.check_and_merge_defaults(options, mandatory, default_options, constraints=None, dict_name=None)

First, check that all keys in mandatory appear in options. Second, create result_options by merging options and default_options, where entries in options have precedence. Finally, if constraints is given, this is used to check validity of values.

Parameters:

• options (Dict[str, Any]) – Input arguments

• mandatory (Set[str]) – Set of mandatory argument names

• default_options (Dict[str, Any]) – Default values for options

• constraints (Optional[Dict[str, CheckType]]) – See above, optional

• dict_name (Optional[str]) – Prefix used in assert messages, optional

Return type:

Dict[str, Any]

Returns:

Output arguments

syne_tune.optimizer.schedulers.searchers.utils.default_arguments.filter_by_key(options, remove_keys)

Filter options by removing entries whose keys are in remove_keys. Used to filter kwargs passed to a constructor, before passing it to the superclass constructor.

Parameters:

• options (Dict[str, Any]) – Arguments to be filtered

• remove_keys (Set[str]) – See above

Return type:

Dict[str, Any]

Returns:

Filtered options

syne_tune.optimizer.schedulers.searchers.utils.default_arguments.assert_no_invalid_options(options, all_keys, name)