utilities Módulo

Métodos de utilidad para la validación y conversión.

Clases

suppress_stdout_stderr

Un administrador de contexto para realizar una "supresión profunda" de stdout y stderr.

Suprimirá toda la impresión, incluso si esta se origina en una subfunción de C o Fortran compilada. No suprimirá las excepciones producidas, ya que las excepciones se imprimen en stderr justo antes de que se cierre un script y después de que el administrador de contexto haya salido.

Cree el administrador de contexto.

Funciones

convert_dict_values_to_str

Convierte los valores de un diccionario para que cada valor sea una cadena.

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

Parámetros

Nombre Description
input_dict
Requerido

el diccionario que se debe convertir

Devoluciones

Tipo Description

un diccionario con todos los valores convertidos en cadenas

get_default_metric_with_objective

Obtiene el diccionario de métricas -> objetivo de la tarea dada.

get_default_metric_with_objective(task)

Parámetros

Nombre Description
task
Requerido

Cadena "clasificación" o "regresión"

Devoluciones

Tipo Description

diccionario de métricas -> objetivo

get_error_code

Compile el código de error a partir de una excepción.

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

Parámetros

Nombre Description
exception
Requerido

Excepción que produce un error en la ejecución.

as_hierarchy

Si se debe devolver la jerarquía de errores completa

Valor predeterminado: False

Devoluciones

Tipo Description

Devuelve el str que contiene error_code. Si as_hierarchy es True, la jerarquía devuelta se une mediante "."

get_min_points

Devuelve el número mínimo de puntos de datos necesarios para el entrenamiento.

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

Parámetros

Nombre Description
window_size
Requerido

el tamaño del período sucesivo.

lags
Requerido

Tamaño del retardo.

max_horizon
Requerido

la longitud deseada de la previsión.

cv
Requerido

el número de validaciones cruzadas.

n_step

Número de períodos entre origin_time de un plegado CV y el siguiente plegado. Por ejemplo, si n_step = 3 para los datos diarios, la hora de origen de cada plegado será de tres días de diferencia.

Valor predeterminado: None

Devoluciones

Tipo Description

el número mínimo de puntos de datos.

get_primary_metrics

Obtiene las métricas principales admitidas para una tarea determinada como una lista.

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

Parámetros

Nombre Description
task
Requerido
str

Tipo de tarea compatible con AutoML, tal y como se define en azureml.automl.core.shared.constants.Tasks

Devoluciones

Tipo Description

Lista de las métricas principales admitidas para la tarea.

get_value_float

Convierte el valor de cadena en float. :param floatstring: el valor de entrada que se va a convertir. :type floatstring: str :return: el valor convertido. :rtype: float

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

Parámetros

Nombre Description
floatstring
Requerido

get_value_from_dict

Obtiene el valor de un elemento de configuración que tiene una lista de nombres.

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

Parámetros

Nombre Description
dictionary
Requerido

Diccionario de valores con par de clave-valor para buscar los datos.

names
Requerido

Lista de nombres para el elemento que busca.

default_value
Requerido

Valor predeterminado devuelto si no se encuentra la clave coincidente

Devoluciones

Tipo Description

Devuelve el primer valor de la lista de nombres.

get_value_int

Convierte un valor de cadena en int.

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

Parámetros

Nombre Description
intstring
Requerido
str

Valor que se va a convertir.

Devoluciones

Tipo Description
int

El valor convertido.

interpret_exception

Traduce una excepción a una excepción AzureMLException.

Si la excepción ya es uno de los tipos conocidos (por ejemplo, ServiceException, AzureMLException), devuelve la excepción tal y como está.

Nota para desarrolladores: Si vemos que se agregan más excepciones o nuevas interpretaciones de ejecuciones remotas en comparación con las de ejecuciones locales, considere la posibilidad de convertir esta funcionalidad en su propia clase

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

Parámetros

Nombre Description
exception
Requerido

Objeto de excepción que debe interpretarse

is_aml_compute

Si el contexto es un servicio de ejecución administrada ejecutado en un proceso de AML Compute (por ejemplo, OSErrors, es posible que los errores de red deban interpretarse de forma diferente en función del tipo de ejecución)

Valor predeterminado: True
kwargs
Requerido

Cualquier propiedad de tiempo de ejecución esperada por ErrorDefinition (por ejemplo, reference_code)

Devoluciones

Tipo Description

excepción interpretada como una excepción AzureMLException con código de error

is_known_date_time_format

Compruebe si una cadena determinada coincide con las expresiones regulares de fecha y hora conocidas.

is_known_date_time_format(datetime_str: str) -> bool

Parámetros

Nombre Description
datetime_str
Requerido

Cadena de entrada para comprobar si es una fecha o no

Devoluciones

Tipo Description

Si la cadena especificada tiene un formato de fecha y hora conocido o no.

minimize_or_maximize

Selecciona el objetivo según una métrica.

Algunas métricas deben minimizarse y otras maximizarse. :param metric: el nombre de la métrica que se va a buscar. :param task: una de las constantes. Tareas. :return: devuelve una de las constantes. OptimizerObjectives.

minimize_or_maximize(metric, task=None)

Parámetros

Nombre Description
metric
Requerido
task
Valor predeterminado: None
subsampling_recommended(num_samples)

Parámetros

Nombre Description
num_samples
Requerido
int

número de muestras.

Devoluciones

Tipo Description

True si se recomiendan las submuestras; de lo contrario, False.

to_ordinal_string

Convierte un entero en una cadena ordinal.

to_ordinal_string(integer: int) -> str

Parámetros

Nombre Description
integer
Requerido