AutoMLRun Classe

  • Referência

Representa uma execução de experimentação de ML automatizada no Azure Machine Learning.

A classe AutoMLRun pode ser utilizada para gerir uma execução, verificar o estado da execução e obter os detalhes da execução assim que uma execução de AutoML for submetida. Para obter mais informações sobre como trabalhar com execuções de experimentação, consulte a Run classe.

Inicializar uma execução de AutoML.

Herança
Run
AutoMLRun

Construtor

AutoMLRun(experiment, run_id, **kwargs)

Parâmetros

Name Description
experiment
Necessário
Experiment

A experimentação associada à execução.
run_id
Necessário
str

O ID da execução.
experiment
Necessário
Experiment

A experimentação associada à execução.
run_id
Necessário
str

O ID da execução.

Observações

Um objeto AutoMLRun é devolvido quando utiliza o submit método de uma experimentação.

Para obter uma execução que já foi iniciada, utilize o seguinte código:


   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

Cancelar uma execução de AutoML.

Devolver Verdadeiro se a execução do AutoML tiver sido cancelada com êxito.
cancel_iteration

Cancelar uma execução subordinada específica.
complete

Conclua uma Execução de AutoML.
continue_experiment

Continue uma experimentação de AutoML existente.
fail

Falhar uma Execução de AutoML.

Opcionalmente, defina a propriedade Error da execução com uma mensagem ou exceção transmitida para error_details.
get_best_child

Devolver a execução subordinada com a melhor classificação para esta Execução de AutoML.
get_guardrails

Imprima e devolva resultados detalhados da execução da verificação do Guardrail.
get_output

Devolver a execução com o melhor pipeline correspondente que já foi testado.

Se não forem fornecidos parâmetros de entrada, get_output devolve o melhor pipeline de acordo com a métrica primária. Em alternativa, pode utilizar o iteration parâmetro ou metric para obter uma iteração específica ou a melhor execução por métrica fornecida, respetivamente.
get_run_sdk_dependencies

Obtenha as dependências de execução do SDK para uma determinada execução.
pause

Devolver Verdadeiro se a execução do AutoML tiver sido colocada em pausa com êxito.

Este método não está implementado.
register_model

Registe o modelo com o serviço ACI do AzureML.
resume

Devolver Verdadeiro se a execução de AutoML tiver sido retomada com êxito.

Este método não está implementado.
retry

Devolver Verdadeiro se a execução do AutoML tiver sido repetida com êxito.

Este método não está implementado.
summary

Obtenha uma tabela que contenha um resumo dos algoritmos tentados e as respetivas pontuações.
wait_for_completion

Aguarde pela conclusão desta execução.

Devolve o objeto de estado após a espera.

cancel

Cancelar uma execução de AutoML.

Devolver Verdadeiro se a execução do AutoML tiver sido cancelada com êxito.

cancel()

Devoluções

Tipo Description

Nenhuma

cancel_iteration

Cancelar uma execução subordinada específica.

cancel_iteration(iteration)

Parâmetros

Name Description
iteration
Necessário
int

A iteração a cancelar.

Devoluções

Tipo Description

Nenhuma

complete

Conclua uma Execução de AutoML.

complete(**kwargs)

Devoluções

Tipo Description

Nenhuma

continue_experiment

Continue uma experimentação 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

Name Description
X
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

Funcionalidades de formação.

Default value: None
y
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

Etiquetas de preparação.

Default value: None
sample_weight
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

Pesos de exemplo para dados de preparação.

Default value: None
X_valid
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

Funcionalidades de validação.

Default value: None
y_valid
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

Etiquetas de validação.

Default value: None
sample_weight_valid
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

pesos de exemplo do conjunto de validação.

Default value: None
data
DataFrame

Funcionalidades e etiquetas de preparação.

Default value: None
label
str

Etiquetar coluna nos dados.

Default value: None
columns
list(str)

Uma lista de colunas permitidas nos dados a utilizar como funcionalidades.

Default value: None
cv_splits_indices
ndarray

Indica onde dividir os dados de preparação para validação cruzada. Cada linha é uma dobra cruzada separada e dentro de cada pasta cruzada, fornece 2 matrizes, a primeira com os índices para exemplos a utilizar para a preparação de dados e a segunda com os índices a utilizar para dados de validação. ou seja, [[t1, v1], [t2, v2], ...] em que t1 é o índice de preparação para a primeira dobra cruzada e v1 são os índices de validação para a primeira dobra cruzada.

Default value: None
spark_context
<xref:SparkContext>

Contexto do Spark, apenas aplicável quando utilizado no ambiente do Azure Databricks/Spark.

Default value: None
experiment_timeout_hours
float

Quantas horas adicionais para executar esta experimentação.

Default value: None
experiment_exit_score
int

Se especificado indicar que a experimentação é terminada quando este valor é atingido.

Default value: None
iterations
int

Quantas iterações adicionais executar para esta experimentação.

Default value: None
show_output
bool

Sinalizador que indica se pretende imprimir a saída para a consola.

Default value: False
training_data
<xref:azureml.dataprep.Dataflow> ou DataFrame

Introduzir dados de preparação.

Default value: None
validation_data
<xref:azureml.dataprep.Dataflow> ou DataFrame

Dados de validação.

Default value: None

Devoluções

Tipo Description
AutoMLRun

A execução principal do AutoML.

Exceções

Tipo Description
ConfigException
InvalidRunState

fail

Falhar uma Execução de AutoML.

Opcionalmente, defina a propriedade Error da execução com uma mensagem ou exceção transmitida para error_details.

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

Parâmetros

Name Description
error_details
str ou BaseException

Detalhes opcionais do erro.

Default value: None
error_code
str

Código de erro opcional do erro para a classificação de erros.

Default value: None
_set_status
bool

Indica se pretende enviar o evento de estado para controlo.

Default value: True

get_best_child

Devolver a execução subordinada com a melhor classificação para esta Execução de AutoML.

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

Parâmetros

Name Description
metric
str

A métrica a utilizar ao selecionar a melhor execução a devolver. A predefinição é a métrica primária.

Default value: None
onnx_compatible

Se pretende devolver apenas execuções que geraram modelos onnx.

Default value: False
kwargs
Necessário

Devoluções

Tipo Description

Execução Subordinada de AutoML.

get_guardrails

Imprima e devolva resultados detalhados da execução da verificação do Guardrail.

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

Parâmetros

Name Description
to_console
bool

Indica se deve escrever os resultados da verificação na consola do .

Default value: True

Devoluções

Tipo Description
dict

Um dicionário de resultados do verificador.

Exceções

Tipo Description
UserErrorException

get_output

Devolver a execução com o melhor pipeline correspondente que já foi testado.

Se não forem fornecidos parâmetros de entrada, get_output devolve o melhor pipeline de acordo com a métrica primária. Em alternativa, pode utilizar o iteration parâmetro ou metric para obter uma iteração específica ou a melhor execução por métrica fornecida, respetivamente.

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

Name Description
iteration
int

O número de iteração da execução correspondente e do modelo ajustado a devolver.

Default value: None
metric
str

A métrica a utilizar ao selecionar a melhor execução e modelo ajustado a devolver.

Default value: None
return_onnx_model
bool

Este método devolverá o modelo ONNX convertido se o enable_onnx_compatible_models parâmetro tiver sido definido como Verdadeiro no AutoMLConfig objeto.

Default value: False
return_split_onnx_model
SplitOnnxModelName

O tipo do modelo de onnx dividido a devolver

Default value: None

Devoluções

Tipo Description
Run, <xref:Model>

A execução, o modelo ajustado correspondente.

Exceções

Tipo Description
ConfigException
OnnxConvertException
NotFoundException

Observações

Se quiser inspecionar os pré-processadores e algoritmos (avaliador) utilizados, pode fazê-lo através Model.stepsde , semelhante a sklearn.pipeline.Pipeline.steps. Por exemplo, o código abaixo mostra como obter o avaliador.


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

get_run_sdk_dependencies

Obtenha as dependências de execução do SDK para uma determinada execução.

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

Parâmetros

Name Description
iteration
int

O número de iteração da execução ajustada a obter. Se Não, obtenha o ambiente principal.

Default value: None
check_versions
bool

Se for Verdadeiro, verifique as versões com o ambiente atual. Se for Falso, passe.

Default value: True

Devoluções

Tipo Description
dict

O dicionário de dependências obtido a partir do RunHistory.

Exceções

Tipo Description
ConfigException

pause

Devolver Verdadeiro se a execução do AutoML tiver sido colocada em pausa com êxito.

Este método não está implementado.

pause()

Exceções

Tipo Description
NotImplementedError

register_model

Registe o modelo com o serviço ACI do AzureML.

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

Parâmetros

Name Description
model_name
str

O nome do modelo que está a ser implementado.

Default value: None
description
str

A descrição do modelo que está a ser implementado.

Default value: None
tags
dict

Etiquetas para o modelo que está a ser implementado.

Default value: None
iteration
int

Substitua o modelo a implementar. Implementa o modelo para uma determinada iteração.

Default value: None
metric
str

Substitua o modelo a implementar. Implementa o melhor modelo para uma métrica diferente.

Default value: None

Devoluções

Tipo Description
<xref:Model>

O objeto de modelo registado.

resume

Devolver Verdadeiro se a execução de AutoML tiver sido retomada com êxito.

Este método não está implementado.

resume()

Exceções

Tipo Description
NotImplementedError:

retry

Devolver Verdadeiro se a execução do AutoML tiver sido repetida com êxito.

Este método não está implementado.

retry()

Exceções

Tipo Description
NotImplementedError

summary

Obtenha uma tabela que contenha um resumo dos algoritmos tentados e as respetivas pontuações.

summary()

Devoluções

Tipo Description
DataFrame

DataFrame do Pandas que contém estatísticas do modelo autoML.

wait_for_completion

Aguarde pela conclusão desta execução.

Devolve o objeto de estado após a espera.

wait_for_completion(show_output=False, wait_post_processing=False)

Parâmetros

Name Description
show_output
bool

Indica se pretende mostrar o resultado da execução em sys.stdout.

Default value: False
wait_post_processing
bool

Indica se deve aguardar que o processamento pós-processamento seja concluído após a conclusão da execução.

Default value: False

Devoluções

Tipo Description
dict

O objeto de estado.

Exceções

Tipo Description
ExperimentExecutionException

Atributos

run_id

Devolver o ID de execução da execução atual.

Devoluções

Tipo Description
str

O ID de execução da execução atual.