def from_config(cls, config_dict, merge_default=True):
"""
Instantiate a new instance of this class given the configuration
JSON-compliant dictionary encapsulating initialization arguments.
This method should not be called via super unless and instance of the
class is desired.
:param config_dict: JSON compliant dictionary encapsulating
a configuration.
:type config_dict: dict
:param merge_default: Merge the given configuration on top of the
default provided by ``get_default_config``.
:type merge_default: bool
:return: Constructed instance from the provided config.
:rtype: ClassificationElementFactory
"""
if merge_default:
mc = cls.get_default_config()
merge_dict(mc, config_dict)
config_dict = mc
return ClassificationElementFactory(
get_classification_element_impls()[config_dict['type']],
config_dict[config_dict['type']]
)
def from_config(cls, config_dict, merge_default=True):
"""
Instantiate a new instance of this class given the configuration
JSON-compliant dictionary encapsulating initialization arguments.
This method should not be called via super unless and instance of the
class is desired.
:param config_dict: JSON compliant dictionary encapsulating
a configuration.
:type config_dict: dict
:param merge_default: Merge the given configuration on top of the
default provided by ``get_default_config``.
:type merge_default: bool
:return: Constructed instance from the provided config.
:rtype: ClassificationElementFactory
"""
if merge_default:
mc = cls.get_default_config()
merge_dict(mc, config_dict)
config_dict = mc
return ClassificationElementFactory(
get_classification_element_impls()[config_dict['type']],
config_dict[config_dict['type']])
def get_default_config(cls):
"""
Generate and return a default configuration dictionary for this class.
This will be primarily used for generating what the configuration
dictionary would look like for this class without instantiating it.
It is not be guaranteed that the configuration dictionary returned
from this method is valid for construction of an instance of this class.
:return: Default configuration dictionary for the class.
:rtype: dict
"""
return make_config(get_classification_element_impls())
def get_default_config(cls):
"""
Generate and return a default configuration dictionary for this class.
This will be primarily used for generating what the configuration
dictionary would look like for this class without instantiating it.
It is not be guaranteed that the configuration dictionary returned
from this method is valid for construction of an instance of this class.
:return: Default configuration dictionary for the class.
:rtype: dict
"""
return make_config(get_classification_element_impls())
def default_config():
return {
"utility": {
"classify_overwrite": False,
"parallel": {
"use_multiprocessing": False,
"index_extraction_cores": None,
"classification_cores": None,
}
},
"plugins": {
"classifier":
plugin.make_config(get_classifier_impls()),
"classification_factory":
plugin.make_config(get_classification_element_impls()),
"descriptor_index":
plugin.make_config(get_descriptor_index_impls()),
}
}
def from_config(cls, config_dict):
"""
Instantiate a new instance of this class given the configuration
JSON-compliant dictionary encapsulating initialization arguments.
This method should not be called via super unless and instance of the
class is desired.
:param config_dict: JSON compliant dictionary encapsulating
a configuration.
:type config_dict: dict
:return: Constructed instance from the provided config.
:rtype: ClassificationElementFactory
"""
mc = cls.get_default_config()
mc.update(config_dict)
return ClassificationElementFactory(
get_classification_element_impls()[mc['type']], mc[mc['type']])
def default_config():
return {
"utility": {
"classify_overwrite": False,
"parallel": {
"use_multiprocessing": False,
"index_extraction_cores": None,
"classification_cores": None,
}
},
"plugins": {
"classifier": plugin.make_config(get_classifier_impls()),
"classification_factory": plugin.make_config(
get_classification_element_impls()
),
"descriptor_index": plugin.make_config(
get_descriptor_index_impls()
),
}
}
def from_config(cls, config_dict):
"""
Instantiate a new instance of this class given the configuration
JSON-compliant dictionary encapsulating initialization arguments.
This method should not be called via super unless and instance of the
class is desired.
:param config_dict: JSON compliant dictionary encapsulating
a configuration.
:type config_dict: dict
:return: Constructed instance from the provided config.
:rtype: ClassificationElementFactory
"""
mc = cls.get_default_config()
mc.update(config_dict)
return ClassificationElementFactory(
get_classification_element_impls()[mc['type']],
mc[mc['type']]
)
