AutoMLRun Clase

Referencia

Representa una ejecución de experimento de ML automatizado en Azure Machine Learning.

La clase AutoMLRun se puede usar para administrar una ejecución, comprobar el estado de la ejecución y recuperar los detalles de la ejecución una vez enviada una ejecución de AutoML. Para más información sobre cómo trabajar con ejecuciones de experimentos, consulte la clase Run.

Inicialice una ejecución de AutoML.

Herencia: Run

AutoMLRun

Constructor

AutoMLRun(experiment, run_id, **kwargs)

Parámetros

Nombre	Description
experiment Requerido	Experiment Experimento asociado a la ejecución.
run_id Requerido	str Identificador de la ejecución.
experiment Requerido	Experiment Experimento asociado a la ejecución.
run_id Requerido	str Identificador de la ejecución.

Comentarios

Se devuelve un objeto AutoMLRun cuando se usa el método submit de un experimento.

Para recuperar una ejecución que ya se ha iniciado, use el código siguiente:


   from azureml.train.automl.run import AutoMLRun
   ws = Workspace.from_config()
   experiment = ws.experiments['my-experiment-name']
   automl_run = AutoMLRun(experiment, run_id = 'AutoML_9fe201fe-89fd-41cc-905f-2f41a5a98883')

Métodos

cancel	Cancela una ejecución de AutoML. Devuelve True si la ejecución de AutoML se canceló correctamente.
cancel_iteration	Cancela una ejecución secundaria determinada.
complete	Completa una ejecución de AutoML.
continue_experiment	Continúa un experimento de AutoML existente.
fail	Error en una ejecución de AutoML. Opcionalmente, establezca la propiedad Error de la ejecución con un mensaje o una excepción que se pasan a `error_details`.
get_best_child	Devuelve la ejecución secundaria con la mejor puntuación para esta ejecución de AutoML.
get_guardrails	Imprime y devuelve los resultados detallados a partir de la comprobación del límite de protección.
get_output	Devuelve la ejecución con la mejor canalización correspondiente que ya se ha probado. Si no se proporcionan parámetros de entrada, `get_output` devuelve la mejor canalización según la métrica principal. Como alternativa, puede usar el parámetro `iteration` o `metric` para recuperar una iteración determinada o la mejor ejecución por cada métrica proporcionada, respectivamente.
get_run_sdk_dependencies	Obtiene las dependencias de ejecución del SDK para una ejecución determinada.
pause	Devuelve True si la ejecución de AutoML se puso en pausa correctamente. Este método no se implementa.
register_model	Registra el modelo con el servicio ACI de AzureML.
resume	Devuelve True si la ejecución de AutoML se reanudó correctamente. Este método no se implementa.
retry	Devuelve True si la ejecución de AutoML se reintentó correctamente. Este método no se implementa.
summary	Obtiene una tabla que contiene un resumen de los algoritmos intentados y sus puntuaciones.
wait_for_completion	Espera a que se complete esta ejecución. Devuelve el objeto de estado después de la espera.

cancel

Cancela una ejecución de AutoML.

Devuelve True si la ejecución de AutoML se canceló correctamente.

cancel()

Devoluciones

Tipo	Description
	None

cancel_iteration

Cancela una ejecución secundaria determinada.

cancel_iteration(iteration)

Parámetros

Nombre	Description
iteration Requerido	int Iteración que se va a cancelar.

Devoluciones

Tipo	Description
	None

complete

Completa una ejecución de AutoML.

complete(**kwargs)

Devoluciones

Tipo	Description
	None

continue_experiment

Continúa un experimento de AutoML existente.

continue_experiment(X=None, y=None, sample_weight=None, X_valid=None, y_valid=None, sample_weight_valid=None, data=None, label=None, columns=None, cv_splits_indices=None, spark_context=None, experiment_timeout_hours=None, experiment_exit_score=None, iterations=None, show_output=False, training_data=None, validation_data=None, **kwargs)

Parámetros

Nombre	Description
X	DataFrame o ndarray o <xref:azureml.dataprep.Dataflow> Características de entrenamiento. Valor predeterminado: None
y	DataFrame o ndarray o <xref:azureml.dataprep.Dataflow> Etiquetas de entrenamiento. Valor predeterminado: None
sample_weight	DataFrame o ndarray o <xref:azureml.dataprep.Dataflow> Ponderaciones de muestra para los datos de entrenamiento. Valor predeterminado: None
X_valid	DataFrame o ndarray o <xref:azureml.dataprep.Dataflow> Características de validación. Valor predeterminado: None
y_valid	DataFrame o ndarray o <xref:azureml.dataprep.Dataflow> Etiquetas de validación. Valor predeterminado: None
sample_weight_valid	DataFrame o ndarray o <xref:azureml.dataprep.Dataflow> Ponderaciones de muestra del conjunto de validación. Valor predeterminado: None
data	DataFrame Características y etiquetas de entrenamiento. Valor predeterminado: None
label	str Columna de etiqueta en los datos. Valor predeterminado: None
columns	list(str) Lista de columnas permitidas en los datos que se usarán como características. Valor predeterminado: None
cv_splits_indices	ndarray Índices donde dividir los datos de entrenamiento para la validación cruzada. Cada fila es un plegamiento cruzado independiente y, dentro de cada uno de ellos, se proporcionan 2 matrices, la primera con los índices para las muestras que se usarán para los datos de entrenamiento y la segunda con los índices que se usarán para los datos de validación. Es decir, [[t1, v1], [t2, v2], ...] donde t1 son los índices de entrenamiento para el primer plegamiento cruzado y v1 son los índices de validación para el primer plegamiento cruzado. Valor predeterminado: None
spark_context	<xref:SparkContext> Contexto de Spark; solo es aplicable cuando se usa en el entorno de Azure Databricks y Spark. Valor predeterminado: None
experiment_timeout_hours	float Número de horas adicionales para ejecutar este experimento. Valor predeterminado: None
experiment_exit_score	int Si se especifica, indica que el experimento finaliza cuando se alcanza este valor. Valor predeterminado: None
iterations	int Número de iteraciones adicionales que se ejecutarán para este experimento. Valor predeterminado: None
show_output	bool Marca que indica si se va a imprimir la salida en la consola. Valor predeterminado: False
training_data	<xref:azureml.dataprep.Dataflow> o DataFrame Datos de entrenamiento de entrada. Valor predeterminado: None
validation_data	<xref:azureml.dataprep.Dataflow> o DataFrame Datos de validación. Valor predeterminado: None

Devoluciones

Tipo	Description
AutoMLRun	Ejecución primaria de AutoML.

Excepciones

Tipo	Description
ConfigException
InvalidRunState

fail

Error en una ejecución de AutoML.

Opcionalmente, establezca la propiedad Error de la ejecución con un mensaje o una excepción que se pasan a error_details.

fail(error_details=None, error_code=None, _set_status=True, **kwargs)

Parámetros

Nombre	Description
error_details	str o BaseException Detalles opcionales del error. Valor predeterminado: None
error_code	str Código de error opcional para la clasificación de errores. Valor predeterminado: None
_set_status	bool Indica si se va a enviar el evento de estado para el seguimiento. Valor predeterminado: True

get_best_child

Devuelve la ejecución secundaria con la mejor puntuación para esta ejecución de AutoML.

get_best_child(metric: str | None = None, onnx_compatible: bool = False, **kwargs: Any) -> Run

Parámetros

Nombre	Description
metric	str Métrica que se va a usar al seleccionar la mejor ejecución que se va a devolver. El valor predeterminado es la métrica principal. Valor predeterminado: None
onnx_compatible	Indica si solo se devuelven las ejecuciones que generaron modelos ONNX. Valor predeterminado: False
kwargs Requerido

Devoluciones

Tipo	Description
	Ejecución secundaria de AutoML.

get_guardrails

Imprime y devuelve los resultados detallados a partir de la comprobación del límite de protección.

get_guardrails(to_console: bool = True) -> Dict[str, Any]

Parámetros

Nombre	Description
to_console	bool Indica si se deben escribir los resultados de la comprobación en la consola. Valor predeterminado: True

Devoluciones

Tipo	Description
dict	Diccionario de los resultados del comprobador.

Excepciones

Tipo	Description
UserErrorException

get_output

Devuelve la ejecución con la mejor canalización correspondiente que ya se ha probado.

Si no se proporcionan parámetros de entrada, get_output devuelve la mejor canalización según la métrica principal. Como alternativa, puede usar el parámetro iteration o metric para recuperar una iteración determinada o la mejor ejecución por cada métrica proporcionada, respectivamente.

get_output(iteration: int | None = None, metric: str | None = None, return_onnx_model: bool = False, return_split_onnx_model: SplitOnnxModelName | None = None, **kwargs: Any) -> Tuple[Run, Any]

Parámetros

Nombre	Description
iteration	int Número de iteración de la ejecución correspondiente y el modelo ajustado que se va a devolver. Valor predeterminado: None
metric	str Métrica que se va a usar al seleccionar la mejor ejecución y el modelo ajustado que se va a devolver. Valor predeterminado: None
return_onnx_model	bool Este método devolverá el modelo ONNX convertido si el parámetro `enable_onnx_compatible_models` se estableció en True en el objeto AutoMLConfig. Valor predeterminado: False
return_split_onnx_model	SplitOnnxModelName Tipo del modelo ONNX de división que se va a devolver Valor predeterminado: None

Devoluciones

Tipo	Description
Run, <xref:Model>	La ejecución y el modelo ajustado correspondiente.

Excepciones

Tipo	Description
ConfigException
OnnxConvertException
NotFoundException

Comentarios

Si desea inspeccionar los preprocesadores y el algoritmo (estimador) utilizados, puede hacerlo mediante Model.steps, de forma similar a sklearn.pipeline.Pipeline.steps. Por ejemplo, el código siguiente muestra cómo recuperar el estimador.


   best_run, model = parent_run.get_output()
   estimator = model.steps[-1]

get_run_sdk_dependencies

Obtiene las dependencias de ejecución del SDK para una ejecución determinada.

get_run_sdk_dependencies(iteration=None, check_versions=True, **kwargs)

Parámetros

Nombre	Description
iteration	int Número de iteración de la ejecución ajustada que se va a recuperar. Si es None (Ninguno), recupera el entorno primario. Valor predeterminado: None
check_versions	bool Si es True, comprueba las versiones con el entorno actual. Si es False, superada. Valor predeterminado: True

Devoluciones

Tipo	Description
dict	Diccionario de dependencias recuperado a partir del historial de ejecución.

Excepciones

Tipo	Description
ConfigException

pause

Devuelve True si la ejecución de AutoML se puso en pausa correctamente.

Este método no se implementa.

pause()

Excepciones

Tipo	Description
NotImplementedError

register_model

Registra el modelo con el servicio ACI de AzureML.

register_model(model_name=None, description=None, tags=None, iteration=None, metric=None)

Parámetros

Nombre	Description
model_name	str Nombre del modelo que se va a implementar. Valor predeterminado: None
description	str Descripción del modelo que se va a implementar. Valor predeterminado: None
tags	dict Etiquetas del modelo que se va a implementar. Valor predeterminado: None
iteration	int Invalida para qué modelo se va a implementar. Implementa el modelo para una iteración determinada. Valor predeterminado: None
metric	str Invalida para qué modelo se va a implementar. Implementa el mejor modelo para otra métrica. Valor predeterminado: None

Devoluciones

Tipo	Description
<xref:Model>	Objeto de modelo registrado.

resume

Devuelve True si la ejecución de AutoML se reanudó correctamente.

Este método no se implementa.

resume()

Excepciones

Tipo	Description
NotImplementedError:

retry

Devuelve True si la ejecución de AutoML se reintentó correctamente.

Este método no se implementa.

retry()

Excepciones

Tipo	Description
NotImplementedError

summary

Obtiene una tabla que contiene un resumen de los algoritmos intentados y sus puntuaciones.

summary()

Devoluciones

Tipo	Description
DataFrame	DataFrame de Pandas que contiene estadísticas del modelo de AutoML.

wait_for_completion

Espera a que se complete esta ejecución.

Devuelve el objeto de estado después de la espera.

wait_for_completion(show_output=False, wait_post_processing=False)

Parámetros

Nombre	Description
show_output	bool Indica si se va a mostrar la salida de la ejecución en sys.stdout. Valor predeterminado: False
wait_post_processing	bool Indica si se va a esperar a que se complete el procesamiento posterior una vez completada la ejecución. Valor predeterminado: False

Devoluciones

Tipo	Description
dict	Objeto de estado.

Excepciones

Tipo	Description
ExperimentExecutionException

Atributos

run_id

Devuelve el identificador de ejecución de la ejecución actual.

Devoluciones

Tipo	Description
str	Identificador de ejecución de la ejecución actual.

Compartir a través de

AutoMLRun Clase

Constructor

Parámetros

Comentarios

Métodos

cancel

Devoluciones

cancel_iteration

Parámetros

Devoluciones

complete

Devoluciones

continue_experiment

Parámetros

Devoluciones

Excepciones

fail

Parámetros

get_best_child

Parámetros

Devoluciones

get_guardrails

Parámetros

Devoluciones

Excepciones

get_output

Parámetros

Devoluciones

Excepciones

Comentarios

get_run_sdk_dependencies

Parámetros

Devoluciones

Excepciones

pause

Excepciones

register_model

Parámetros

Devoluciones

resume

Excepciones

retry

Excepciones

summary

Devoluciones

wait_for_completion

Parámetros

Devoluciones

Excepciones

Atributos

run_id

Devoluciones

Comentarios

Recursos adicionales