SpecialCharacters#

class SpecialCharacters[source]#

Search in column[s] for values that contains only special characters.

Parameters
columnsUnion[Hashable, List[Hashable]] , default: None

Columns to check, if none are given checks all columns except ignored ones.

ignore_columnsUnion[Hashable, List[Hashable]] , default: None

Columns to ignore, if none given checks based on columns variable.

n_most_commonint , default: 2

Number of most common special-only samples to show in results

n_top_columnsint , optional

amount of columns to show ordered by feature importance (date, index, label are first)

n_samples: int = 10_000_000,

random_state: int = 42,

__init__(columns: Optional[Union[Hashable, List[Hashable]]] = None, ignore_columns: Optional[Union[Hashable, List[Hashable]]] = None, n_most_common: int = 2, n_top_columns: int = 10, n_samples: int = 10000000, random_state: int = 42, **kwargs)[source]#
__new__(*args, **kwargs)#

Methods

SpecialCharacters.add_condition(name, ...)

Add new condition function to the check.

SpecialCharacters.add_condition_ratio_of_special_characters_less_or_equal([...])

Add condition - ratio of entirely special character in column is less or equal to the threshold.

SpecialCharacters.clean_conditions()

Remove all conditions from this check instance.

SpecialCharacters.conditions_decision(result)

Run conditions on given result.

SpecialCharacters.config([include_version])

Return check configuration (conditions' configuration not yet supported).

SpecialCharacters.from_config(conf[, ...])

Return check object from a CheckConfig object.

SpecialCharacters.from_json(conf[, ...])

Deserialize check instance from JSON string.

SpecialCharacters.metadata([with_doc_link])

Return check metadata.

SpecialCharacters.name()

Name of class in split camel case.

SpecialCharacters.params([show_defaults])

Return parameters to show when printing the check.

SpecialCharacters.remove_condition(index)

Remove given condition by index.

SpecialCharacters.run(dataset[, model, ...])

Run check.

SpecialCharacters.run_logic(context, ...)

Run check.

SpecialCharacters.to_json([indent])

Serialize check instance to JSON string.