Task Registry
- class falcon.task_configurations.TaskConfigurationRegistry
Central registry holding pre-defined configurations for the tasks.
- classmethod get_configuration(task: str, configuration_name: str, allow_extensions_discovery: bool = True) Dict
- Parameters
task (str) – the name of the task
configuration_name (str) – the name of the configuration
allow_extensions_discovery (bool, optional) – if True falcon will try to import an extension module for a given config (config module is determined based on config name), by default True
- Returns
task configuration
- Return type
Dict
- classmethod get_registered_config_names(task: str) List[str]
- Parameters
task (str) – the name of the task
- Returns
a list of registered configuration names for a given task
- Return type
List[str]
- classmethod get_registered_tasks() List[str]
Returns the list of registered tasks.
- Returns
list of registered tasks
- Return type
List[str]
- classmethod get_task_manager(task: str) Type[TaskManager]
- Parameters
task (str) – the name of the task
- Returns
TaskNanager class for the given task
- Return type
Type[TaskManager]
- classmethod is_known_task(task: str) bool
- Parameters
task (str) – the name of the task
- Returns
True if the task is registered, else False
- Return type
bool
- classmethod load_extension(extension_name: str) None
Imports the extension module, module name should follow the naming scheme falcon_ml_<extension_name>.
- Parameters
extension_name (str) – the name of the extension
- classmethod register_configurations(task: str, config: Dict, silent: bool = False) None
Register configuration for the task.
- Parameters
task (str) – the name of the task
config (Dict) – the name of the configuration, should follow the naming scheme EXTENSION_NAME::config_name
silent (bool, optional) – prints config name on registration if True, by default False
- classmethod register_task(task: str, task_manager: Type[TaskManager]) None
Registers a new task.
- Parameters
task (str) – name of the task (e.g. tabular_regression)
task_manager (Type[TaskManager]) – TaskManager responsible for handling the task