FeatureMetadata.add_special_types¶

FeatureMetadata.add_special_types(type_map_special: Dict[str, List[str]], inplace=False)[source]¶

Adds special types to features.

Parameters:

type_map_special (Dict[str, List[str]]) – Dictionary of feature -> list of special types to add. Features in dictionary must already exist in the FeatureMetadata object.
inplace (bool, default False) – If True, updates self inplace and returns self. If False, updates a copy of self and returns copy.

Return type:

FeatureMetadata object.

Examples

>>> from autogluon.common.features.feature_metadata import FeatureMetadata
>>> feature_metadata = FeatureMetadata({'FeatureA': 'int', 'FeatureB': 'object'})
>>> feature_metadata = feature_metadata.add_special_types({'FeatureA': ['MySpecialType'], 'FeatureB': ['MySpecialType', 'text']})