Repository

class fedot.core.repository.dataset_types.DataTypesEnum(value)[source]

Bases: golem.utilities.data_structures.ComparableEnum

An enumeration

Parameters

  • table – table with columns as features for predictions, by default == feature_table

  • ts – one dimensional array - time series, by default == time_series

  • multi_ts – table with different variant of time-series for the same variable as columns (used for extending train sample), by default == multiple_time_series

  • text – table, where cells contains text, by default == text

  • image – images represented as 3d arrays, by default == image

Operation Types

class fedot.core.repository.operation_types_repository.OperationMetaInfo(id: str, input_types: List[DataTypesEnum], output_types: List[DataTypesEnum], task_type: List[TaskTypesEnum], supported_strategies: Union[ForwardRef('EvaluationStrategy'), Dict[str, ForwardRef('EvaluationStrategy')]], allowed_positions: List[str], tags: Union[List[str], NoneType] = None, presets: Union[List[str], NoneType] = None)[source]

Bases: object

Parameters
Return type

None

current_strategy(task)[source]

Gets available processing strategies depending on the selected task

Parameters

task (TaskTypesEnum) – machine learning task (e.g. regression and classification)

Returns

supported strategies for task

Return type

Optional[EvaluationStrategy]

class fedot.core.repository.operation_types_repository.OperationTypesRepository(operation_type='model')[source]

Bases: object

Class for connecting models and data operations with json files with its descriptions and metadata

Parameters

operation_type (str) –

classmethod _initialise_repo(repo_path)[source]

Method parse JSON repository with operations descriptions and wrapped information into OperationMetaInfo, then put it into the list

Returns

list with OperationMetaInfo for every operation from json repository

Return type

List[OperationMetaInfo]

Parameters

repo_path (str) –

static get_strategies_by_metadata(metadata)[source]

Obtains strategy instance by the metadata

Parameters

metadata (dict) – information about meta of the operation

Returns

available strategies for current metadata

Return type

Union[EvaluationStrategy, Dict[str, EvaluationStrategy]]

operation_info_by_id(operation_id)[source]

Get operation by it’s name (id)

Parameters

operation_id (str) –

Return type

Optional[OperationMetaInfo]

operations_with_tag(tags, is_full_match=False)[source]

Method returns operations from repository with specific tags

Parameters

  • tags (List[str]) – list of required tags

  • is_full_match (bool) – are all tags are required

:return list of suitable operations names

suitable_operation(task_type=None, data_type=None, tags=None, is_full_match=False, forbidden_tags=None, preset=None)[source]

Method returns operations from repository for desired task and / or tags. Filtering method.

Parameters

  • task_type (Optional[TaskTypesEnum]) – task to filter

  • data_type (Optional[DataTypesEnum]) – data type to filter

  • tags (Optional[List[str]]) – operations with which tags are required

  • is_full_match (bool) – requires all tags to match, or at least one

  • forbidden_tags (Optional[List[str]]) – operations with such tags shouldn’t be returned

  • preset (Optional[str]) – return operations from desired preset

Return type

List[str]

get_first_suitable_operation_tag(operation, tags_to_find=None)[source]

Finds the first suitable tag for the operation in the repository.

Parameters

  • operation (str) – name of the operation

  • tags_to_find (Optional[List[str]]) – list of suitable tags. The later the tag, the higher its priority in case of intersection

Returns

first suitable tag or None

Return type

Optional[List[str]]

fedot.core.repository.operation_types_repository.get_visualization_tags_map()[source]

Returns map between repository tags and list of corresponding models for visualizations.

Return type

Dict[str, List[str]]

fedot.core.repository.operation_types_repository._is_operation_contains_tag(candidate_tags, operation_tags, is_full_match)[source]

The function checks which operations are suitable for the selected tags

Parameters

  • candidate_tags (List[str]) – list with tags that the operation must have in order to fit the selected task

  • operation_tags (List[str]) – list with tags with names as in repository json file which correspond to the considering operation

  • is_full_match (bool) – requires all tags to match, or at least one

Returns

is there a match on the tags

Return type

bool

fedot.core.repository.operation_types_repository._is_operation_contains_preset(operation_presets, preset)[source]

Checking whether the operation is suitable for current preset

Parameters

  • operation_presets (List[str]) –

  • preset (str) –

Return type

bool

fedot.core.repository.operation_types_repository.get_operations_for_task(task, data_type=None, mode='all', tags=None, forbidden_tags=None, preset=None)[source]

Function returns aliases of operations.

Parameters

  • task (Optional[Task]) – task to solve

  • data_type (Optional[DataTypesEnum]) – type of input data

  • mode –

    mode to return operations

    the possible parameters of mode:

    • all -> return list with all operations

    • model -> return only list with models

    • data_operation -> return only list with data_operations

  • tags – tags for grabbing when filtering

  • forbidden_tags – tags for skipping when filtering

  • preset (Optional[str]) – operations from this preset will be obtained

Returns

operation aliases

Return type

list

fedot.core.repository.operation_types_repository._operation_name_without_postfix(operation_id)[source]
Parameters

operation_id – operation name with optional postfix - text after / sign

Returns

operation type - all characters before postfix (all characters if no postfix found)

Quality metrics

class fedot.core.repository.metrics_repository.MetricsEnum(value)[source]

Bases: golem.utilities.data_structures.ComparableEnum

An enumeration.

class fedot.core.repository.metrics_repository.QualityMetricsEnum(value)[source]

Bases: fedot.core.repository.metrics_repository.MetricsEnum

An enumeration.

class fedot.core.repository.metrics_repository.ComplexityMetricsEnum(value)[source]

Bases: fedot.core.repository.metrics_repository.MetricsEnum

An enumeration.

class fedot.core.repository.metrics_repository.ClusteringMetricsEnum(value)[source]

Bases: fedot.core.repository.metrics_repository.QualityMetricsEnum

An enumeration.

class fedot.core.repository.metrics_repository.ClassificationMetricsEnum(value)[source]

Bases: fedot.core.repository.metrics_repository.QualityMetricsEnum

An enumeration.

class fedot.core.repository.metrics_repository.RegressionMetricsEnum(value)[source]

Bases: fedot.core.repository.metrics_repository.QualityMetricsEnum

An enumeration.

class fedot.core.repository.metrics_repository.TimeSeriesForecastingMetricsEnum(value)[source]

Bases: fedot.core.repository.metrics_repository.QualityMetricsEnum

An enumeration.

class fedot.core.repository.metrics_repository.QualityMetricCallable(*args, **kwargs)[source]

Bases: Protocol

class fedot.core.repository.metrics_repository.ComplexityMetricCallable(*args, **kwargs)[source]

Bases: Protocol

Tasks

class fedot.core.repository.tasks.TaskParams[source]

Bases: object

Return type

None

class fedot.core.repository.tasks.TsForecastingParams(forecast_length: int)[source]

Bases: fedot.core.repository.tasks.TaskParams

Parameters

forecast_length (int) –

Return type

None

class fedot.core.repository.tasks.TaskTypesEnum(value)[source]

Bases: golem.utilities.data_structures.ComparableEnum

An enumeration.

class fedot.core.repository.tasks.Task(task_type: TaskTypesEnum, task_params: Union[TaskParams, NoneType] = None)[source]

Bases: object

Parameters
Return type

None