utilities Módulo

Métodos de utilitário para validação e conversão.

Classes

suppress_stdout_stderr

Um gerenciador de contexto para fazer uma "supressão profunda" de stdout e stderr. Suprimirá todas as impressões, mesmo se a impressão for originada em uma subfunção C/Fortran compilada. Não suprimirá exceções geradas, pois as exceções são impressas em stderr logo antes de um script sair e depois que o gerenciador de contexto foi encerrado. Crie o gerenciador de contexto.

Funções

convert_dict_values_to_str

Converta os valores de um dicionário para que cada valor seja uma cadeia de caracteres.

convert_dict_values_to_str(input_dict: Dict[Any, Any]) -> Dict[str, str]

Parâmetros

Nome	Description
input_dict Obrigatório	o dicionário que deve ser convertido

Retornos

Tipo	Description
	um dicionário com todos os valores convertidos em cadeias de caracteres

get_default_metric_with_objective

Obtém o dicionário de métrica –> objetivo para a tarefa determinada.

get_default_metric_with_objective(task)

Parâmetros

Nome	Description
task Obrigatório	"classificação" ou "regressão" da cadeia de caracteres.

Retornos

Tipo	Description
	dicionário de métrica –> objetivo

get_error_code

Cria o código de erro de uma exceção.

get_error_code(exception: BaseException, as_hierarchy: bool = False) -> str

Parâmetros

Nome	Description
exception Obrigatório	A exceção que falha na execução.
as_hierarchy	Se a hierarquia de erros completa deve ser retornada Valor padrão: False

Retornos

Tipo	Description
	Retorna a str que contém error_code. Se as_hierarchy for True, a hierarquia retornada será unida por um '.'

get_min_points

Retorna o número mínimo de pontos de dados necessários para treinamento.

get_min_points(window_size: int, lags: List[int], max_horizon: int, cv: int | None, n_step: int | None = None) -> int

Parâmetros

Nome	Description
window_size Obrigatório	O tamanho da janela de rolagem.
lags Obrigatório	O tamanho do retardo.
max_horizon Obrigatório	A duração desejada da previsão.
cv Obrigatório	O número de validações cruzadas.
n_step	O número de períodos entre o origin_time de uma dobra de validação cruzada e a próxima dobra. Por exemplo, se n_step = 3 para dados diários, a hora de origem de cada dobra terá três dias de diferença da anterior. Valor padrão: None

Retornos

Tipo	Description
	O número mínimo de pontos de dados.

get_primary_metrics

Obtém as métricas primárias compatíveis para uma determinada tarefa como uma lista.

get_primary_metrics(task: str) -> List[str]

Parâmetros

Nome	Description
task Obrigatório	str Tipo de tarefa com suporte no ML automatizado, conforme definido em azureml.automl.core.shared.constants.Tasks

Retornos

Tipo	Description
	Uma lista das métricas primárias com suporte para a tarefa.

get_value_float

Converte o valor da cadeia de caracteres em float. :param floatstring: O valor de entrada a ser convertido. :type floatstring: str :return: O valor convertido. :rtype: float

get_value_float(floatstring: str) -> float | str | None

Parâmetros

Nome	Description
floatstring Obrigatório

get_value_from_dict

Obtém o valor de um item de configuração que tem uma lista de nomes.

get_value_from_dict(dictionary: Dict[str, Any], names: List[str], default_value: Any) -> Any

Parâmetros

Nome	Description
dictionary Obrigatório	dict Dicionário de configurações com par chave-valor pelo qual procurar os dados.
names Obrigatório	list[str] A lista de nomes para o item sendo pesquisado.
default_value Obrigatório	O valor padrão a ser retornado se nenhuma chave correspondente for encontrada

Retornos

Tipo	Description
	Retorna o primeiro valor da lista de nomes.

get_value_int

Converte o valor da cadeia de caracteres em int.

get_value_int(intstring: str) -> int | str | None

Parâmetros

Nome	Description
intstring Obrigatório	str O valor de entrada a ser convertido.

Retornos

Tipo	Description
int	O valor convertido.

interpret_exception

Traduz uma exceção para uma AzureMLException.

Se a exceção já é de um dos tipos conhecidos (por exemplo, ServiceException, AzureMLException), retorna a exceção como se encontra.

Nota do desenvolvedor: se observarmos a adição de mais exceções ou novas interpretações para as execuções remotas versus locais, considere converter essa funcionalidade em uma classe própria

interpret_exception(exception: BaseException, is_aml_compute: bool = True, **kwargs: Any) -> AzureMLException | ServiceException

Parâmetros

Nome	Description
exception Obrigatório	O objeto de exceção que precisa ser interpretado
is_aml_compute	Se o contexto for uma execução gerenciada do serviço de execução em uma computação do AML (por exemplo, OSErrors e erros de rede talvez precisem ser interpretados de maneira diferente com base no tipo de execução) Valor padrão: True
kwargs Obrigatório	Todas as propriedades de runtime que o ErrorDefinition espera (como reference_code)

Retornos

Tipo	Description
	exceção interpretada como uma AzureMLException com código de erro

is_known_date_time_format

Verifique se uma determinada cadeia de caracteres corresponde às expressões regulares de data e hora conhecidas.

is_known_date_time_format(datetime_str: str) -> bool

Parâmetros

Nome	Description
datetime_str Obrigatório	Cadeia de caracteres de entrada para verificar se é uma data ou não

Retornos

Tipo	Description
	Se a cadeia de caracteres determinada está em um formato de data/hora conhecido ou não

minimize_or_maximize

Selecione o objetivo considerando uma métrica.

Algumas métricas devem ser minimizadas e outras maximizadas :param metric: O nome da métrica a ser pesquisada :param task: Uma das constants.Tasks. :return: Retorna uma das constants.OptimizerObjectives.

minimize_or_maximize(metric, task=None)

Parâmetros

Nome	Description
metric Obrigatório
task	Valor padrão: None

subsampling_recommended

subsampling_recommended(num_samples)

Parâmetros

Nome	Description
num_samples Obrigatório	int Número de amostras.

Retornos

Tipo	Description
bool	True se a subamostragem for recomendada, se não, False.

to_ordinal_string

Converte um inteiro em uma cadeia de caracteres ordinal.

to_ordinal_string(integer: int) -> str

Parâmetros

Nome	Description
integer Obrigatório