selfclean_audio.validation

Centralized validation functions for configuration and parameters.

Members

ValidationError	Custom exception for validation errors.
get_seed_from_config	Extract seed from various possible locations in config.
validate_base_config	Validate basic configuration parameters.
validate_dataloader_config	Validate dataloader configuration parameters.
validate_dataset_paths	Validate dataset path parameters.
validate_duplicate_strategy	Validate and get duplicate strategy from issue type.
validate_full_config	Perform comprehensive configuration validation.
validate_gtzan_config	Validate GTZAN-specific configuration parameters.
validate_issue_type	Validate that the issue type is supported.
validate_off_topic_strategy	Validate and get off-topic strategy from issue type.
validate_required_attributes	Validate that an object has all required attributes.

exception selfclean_audio.validation.ValidationError

Custom exception for validation errors.

selfclean_audio.validation.validate_required_attributes(obj, required_attrs: list[str], context: str = '') → None

Validate that an object has all required attributes.

Parameters:

• obj – Object to validate

• required_attrs – List of required attribute names

• context – Context string for better error messages

Raises:

ValidationError – If any required attribute is missing

selfclean_audio.validation.validate_base_config(cfg: DictConfig) → None

Validate basic configuration parameters.

selfclean_audio.validation.validate_dataset_paths(cfg: DictConfig) → None

Validate dataset path parameters.

selfclean_audio.validation.validate_gtzan_config(cfg: DictConfig) → None

Validate GTZAN-specific configuration parameters.

selfclean_audio.validation.validate_dataloader_config(cfg: DictConfig) → None

Validate dataloader configuration parameters.

selfclean_audio.validation.validate_issue_type(issue_type: str) → None

Validate that the issue type is supported.

Parameters:

issue_type – Issue type to validate

Raises:

ValidationError – If issue type is not supported

selfclean_audio.validation.validate_duplicate_strategy(issue_type: str) → str

Validate and get duplicate strategy from issue type.

Parameters:

issue_type – Issue type for duplicate detection

Returns:

Corresponding duplicate strategy

Return type:

str

Raises:

ValidationError – If issue type is not a valid duplicate type

selfclean_audio.validation.validate_off_topic_strategy(issue_type: str) → str

Validate and get off-topic strategy from issue type.

Parameters:

issue_type – Issue type for off-topic detection

Returns:

Corresponding off-topic strategy

Return type:

str

Raises:

ValidationError – If issue type is not a valid off-topic type

selfclean_audio.validation.get_seed_from_config(cfg: DictConfig) → int

Extract seed from various possible locations in config.

Parameters:

cfg – Configuration object

Returns:

Seed value

Return type:

int

Raises:

ValidationError – If no seed is found in any expected location

selfclean_audio.validation.validate_full_config(cfg: DictConfig) → None

Perform comprehensive configuration validation.

Parameters:

cfg – Configuration object to validate

Raises:

ValidationError – If any validation fails