AutoMLRun Classe

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
AutoMLRun

Construtor

AutoMLRun(experiment, run_id, **kwargs)

Parâmetros

experiment
Experiment
Necessário

A experimentação associada à execução.

run_id
str
Necessário

O ID da execução.

experiment
Experiment
Necessário

A experimentação associada à execução.

run_id
str
Necessário

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

Nenhuma

cancel_iteration

Cancelar uma execução subordinada específica.

cancel_iteration(iteration)

Parâmetros

iteration
int
Necessário

A iteração a cancelar.

Devoluções

Nenhuma

complete

Conclua uma Execução de AutoML.

complete(**kwargs)

Devoluções

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

X
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>
valor predefinido: None

Funcionalidades de formação.

y
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>
valor predefinido: None

Etiquetas de preparação.

sample_weight
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>
valor predefinido: None

Pesos de exemplo para dados de preparação.

X_valid
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>
valor predefinido: None

Funcionalidades de validação.

y_valid
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>
valor predefinido: None

Etiquetas de validação.

sample_weight_valid
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>
valor predefinido: None

pesos de exemplo do conjunto de validação.

data
DataFrame
valor predefinido: None

Funcionalidades e etiquetas de preparação.

label
str
valor predefinido: None

Etiquetar coluna nos dados.

columns
list(str)
valor predefinido: None

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

cv_splits_indices
ndarray
valor predefinido: None

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.

spark_context
<xref:SparkContext>
valor predefinido: None

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

experiment_timeout_hours
float
valor predefinido: None

Quantas horas adicionais para executar esta experimentação.

experiment_exit_score
int
valor predefinido: None

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

iterations
int
valor predefinido: None

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

show_output
bool
valor predefinido: False

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

training_data
<xref:azureml.dataprep.Dataflow> ou DataFrame
valor predefinido: None

Introduzir dados de preparação.

validation_data
<xref:azureml.dataprep.Dataflow> ou DataFrame
valor predefinido: None

Dados de validação.

Devoluções

A execução principal do AutoML.

Tipo de retorno

Exceções

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

error_details
str ou BaseException
valor predefinido: None

Detalhes opcionais do erro.

error_code
str
valor predefinido: None

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

_set_status
bool
valor predefinido: True

Indica se pretende enviar o evento de estado para controlo.

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

metric
str
valor predefinido: None

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

onnx_compatible
valor predefinido: False

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

kwargs
Necessário

Devoluções

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

to_console
bool
valor predefinido: True

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

Devoluções

Um dicionário de resultados do verificador.

Tipo de retorno

Exceções

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

iteration
int
valor predefinido: None

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

metric
str
valor predefinido: None

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

return_onnx_model
bool
valor predefinido: False

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

return_split_onnx_model
SplitOnnxModelName
valor predefinido: None

O tipo do modelo de onnx dividido a devolver

Devoluções

A execução, o modelo ajustado correspondente.

Tipo de retorno

Run, <xref:Model>

Exceções

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

iteration
int
valor predefinido: None

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

check_versions
bool
valor predefinido: True

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

Devoluções

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

Tipo de retorno

Exceções

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

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

model_name
str
valor predefinido: None

O nome do modelo que está a ser implementado.

description
str
valor predefinido: None

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

tags
dict
valor predefinido: None

Etiquetas para o modelo que está a ser implementado.

iteration
int
valor predefinido: None

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

metric
str
valor predefinido: None

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

Devoluções

O objeto de modelo registado.

Tipo de retorno

<xref:Model>

resume

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

Este método não está implementado.

resume()

Exceções

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

summary

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

summary()

Devoluções

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

Tipo de retorno

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

show_output
bool
valor predefinido: False

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

wait_post_processing
bool
valor predefinido: False

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

Devoluções

O objeto de estado.

Tipo de retorno

Exceções

Atributos

run_id

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

Devoluções

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

Tipo de retorno

str