Pular para o conteúdo principal
Versões: 0.4.x

Sanitizers

def sanitize_choice(...)

def sanitize_choice(value: T, valid_choices: Iterable[T], default: T) -> T

A função sanitize_choice(...), retorna o valor se estiver presente no conjunto de opções válidas; caso contrário, retorna o valor padrão.

Parameters:

  • value (T): O valor a ser verificado.
  • valid_choices (Iterable[T]): Uma coleção de opções válidas.
  • default: O valor padrão a ser retornado se value não estiver em valid_choices.

Returns:

  • T: O valor original, se válido, ou o valor padrão, se não.

def sanitize_param(...)

def sanitize_param(value: T, default: T, condition: Callable[[T], bool]) -> T:

A função sanitize_param(...), retorna o valor se ele satisfizer a condição especificada; caso contrário, retorna o valor padrão.

Parameters:

  • value (T): O valor a ser verificado.
  • default (T): O valor padrão a ser retornado se a condição não for satisfeita.
  • condition (Callable[[T], bool]): Uma função que recebe um valor e retorna um booleano, determinando se o valor é válido.

Returns:

  • T: O valor original se a condição for satisfeita, ou o valor padrão se não for.

def sanitize_seed(...)

def sanitize_seed(seed: Any) -> Optional[int]:

A função sanitize_param(...), retorna a semente se for um inteiro não negativo; caso contrário, retorna Nenhum.

Parameters:

  • seed (Any): O valor da seed a ser validado.

Returns:

  • Optional[int]: A seed original se for um inteiro não negativo, ou None se for inválido.

def sanitize_bounds(...)

def sanitize_bounds(bounds: Any, problem_size: int) -> Dict[str, npt.NDArray[np.float64]]

A função sanitize_bounds(...) valida e normaliza os limites das características (features).

Parâmetros:

  • bounds (Any): Os limites de entrada, que devem ser None ou um dicionário com as chaves 'low' e 'high'.
  • problem_size (int): O tamanho esperado para as listas de limites normalizadas, correspondente ao número de features do problema.

Retorna:

  • Dict[str, list]: Dicionário no formato {'low': [low_1, ..., low_N], 'high': [high_1, ..., high_N]}.