Skip to main content
Version: 1.7.1

ScaleCategorizer

classView source ↗
class ScaleCategorizer(
    column_names: str | tuple[str, str | None] | Annotated[list[str], <class 'Strict'>] | Annotated[list[tuple[str, str | None]], <class 'Strict'>] | NoneType = None,
    on_missing_column: Literal['ignore', 'fail'] = 'ignore',
    on_wrong_type: Literal['ignore', 'fail'] = 'ignore',
    on_wrong_scale_value: Literal['ignore', 'fail'] = 'ignore',
    scale: Scale,
    tags: str | list[str] | NoneType = None,
)

Bases: Categorizer

Categories: dq-classifier

A classifier that bucketizes data into bins based on a given scale.

Initializes a categorizer.

Parameters​

parameter
column_names

The column(s) to categorize.

parameter
on_missing_column

What to do if a column name is missing.

parameter
on_wrong_type

Behavior when a column’s type is incompatible with the classifier.

parameter
on_wrong_scale_value

Behavior when the scale's min or max values are incompatible with the column type.

parameter
scale

The scale to use for categorization.

parameter
tags

Optional tags for the classifier.

Properties​

property
column_nameslist[tuple[str, str | None]] | None

Returns the list of columns the classifier applies to, including optional destination column names.

property
on_missing_columnLiteral['ignore', 'fail']

Returns what do if the column is missing.

property
on_wrong_typeLiteral['ignore', 'fail']

Returns what do if the column type is incompatible with the classifier.

property
on_wrong_valueLiteral['ignore', 'fail']

Returns what do if the column type is incompatible with the classifier.

property
scaleScale

Returns the scale used for categorization.

property
tagslist[str] | None

Returns the list of tags associated with the classifier.

Methods​

method
View source ↗
supported_dtypes
def supported_dtypes() -> FrozenSet[Type]

Returns the set of data types supported by categorizers.