ImagePropertyOutliers#

class ImagePropertyOutliers[source]#

Find outliers images with respect to the given properties.

The check computes several image properties and then computes the number of outliers for each property. The check uses IQR to detect outliers out of the single dimension properties.

Parameters

image_propertiesList[Dict[str, Any]], default: None

List of properties. Replaces the default deepchecks properties. Each property is a dictionary with keys 'name' (str), method (Callable) and 'output_type' (str), representing attributes of said method. ‘output_type’ must be one of:

'numerical' - for continuous ordinal outputs.
'categorical' - for discrete, non-ordinal outputs. These can still be numbers, but these numbers do not have inherent value.

For more on image / label properties, see the guide about Vision Properties.

n_show_topint , default: 3

number of outliers to show from each direction (upper limit and bottom limit)

iqr_percentiles: Tuple[int, int], default: (25, 75)

Two percentiles which define the IQR range

iqr_scale: float, default: 1.5

The scale to multiply the IQR range for the outliers detection

min_samplesint , default: 10

Minimum number of samples required to calculate IQR. If there are not enough non-null samples a specific property, the check will skip it. If all properties are skipped, the check will raise a NotEnoughSamplesError.

n_samplesOptional[int] , default10000

Number of samples to use for the check. If None, all samples will be used.

__init__(image_properties: Optional[List[Dict[str, Any]]] = None, n_show_top: int = 3, iqr_percentiles: Tuple[int, int] = (25, 75), iqr_scale: float = 1.5, min_samples: int = 10, n_samples: Optional[int] = 10000, **kwargs)[source]#

__new__(*args, **kwargs)#

Methods

`ImagePropertyOutliers.add_condition`(name, ...)	Add new condition function to the check.
`ImagePropertyOutliers.clean_conditions`()	Remove all conditions from this check instance.
`ImagePropertyOutliers.compute`(context, ...)	Compute final result.
`ImagePropertyOutliers.conditions_decision`(result)	Run conditions on given result.
`ImagePropertyOutliers.config`([...])	Return check configuration (conditions' configuration not yet supported).
`ImagePropertyOutliers.from_config`(conf[, ...])	Return check object from a CheckConfig object.
`ImagePropertyOutliers.from_json`(conf[, ...])	Deserialize check instance from JSON string.
`ImagePropertyOutliers.get_default_properties`(data)	Return default properties to run in the check.
`ImagePropertyOutliers.initialize_run`(...)	Initialize the properties state.
`ImagePropertyOutliers.metadata`([with_doc_link])	Return check metadata.
`ImagePropertyOutliers.name`()	Name of class in split camel case.
`ImagePropertyOutliers.params`([show_defaults])	Return parameters to show when printing the check.
`ImagePropertyOutliers.remove_condition`(index)	Remove given condition by index.
`ImagePropertyOutliers.run`(dataset[, ...])	Run check.
`ImagePropertyOutliers.to_json`([indent, ...])	Serialize check instance to JSON string.
`ImagePropertyOutliers.update`(context, batch, ...)	Aggregate image properties from batch.

Examples#

data_integrity

ImagePropertyOutliers.add_condition