Compartilhar via

AutoMLRun Classe

  • Referência

Representa uma execução de experimento de ML automatizado no Azure Machine Learning.

A classe AutoMLRun pode ser usada para gerenciar uma execução, verificar o status dela e recuperar os detalhes quando uma execução de AutoML é enviada. Para obter mais informações sobre como trabalhar com execuções de experimento, consulte a classe Run.

Inicializar uma execução de AutoML.

Herança
Run
AutoMLRun

Construtor

AutoMLRun(experiment, run_id, **kwargs)

Parâmetros

Nome Description
experiment
Obrigatório
Experiment

O experimento associado à execução.
run_id
Obrigatório
str

A ID da execução.
experiment
Obrigatório
Experiment

O experimento associado à execução.
run_id
Obrigatório
str

A ID da execução.

Comentários

Um objeto AutoMLRun é retornado quando você usa o método submit de um experimento.

Para recuperar uma execução que já foi iniciada, use 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

Cancele uma execução do AutoML.

Retorna true se a execução de AutoML foi cancelada com êxito.
cancel_iteration

Cancelar uma determinada execução filho.
complete

Conclua uma execução do AutoML.
continue_experiment

Continue um experimento AutoML existente.
fail

Falha em uma execução do AutoML.

Há a opção de definir a propriedade de Erro da execução com uma mensagem ou exceção transmitida para error_details.
get_best_child

Retornar a execução do filho com a melhor pontuação para essa execução do AutoML.
get_guardrails

Imprimir e retornar resultados detalhados da execução da verificação de Guardrail.
get_output

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

Se nenhum parâmetro de entrada for fornecido, get_output retornará o melhor pipeline de acordo com a métrica primária. Como alternativa, você pode usar o parâmetro iteration ou metric para recuperar uma iteração específica ou a melhor execução por métrica fornecida, respectivamente.
get_run_sdk_dependencies

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

Retornar True se a execução do AutoML tiver sido pausada com êxito.

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

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

Retorna True se a execução do AutoML é retomada com êxito.

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

Retorna True se a execução do AutoML é tentada novamente com êxito.

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

Obter uma tabela que contém um resumo dos algoritmos tentados e suas pontuações.
wait_for_completion

Aguardar a conclusão desta execução.

Retorna o objeto de status após a espera.

cancel

Cancele uma execução do AutoML.

Retorna true se a execução de AutoML foi cancelada com êxito.

cancel()

Retornos

Tipo Description

Nenhum

cancel_iteration

Cancelar uma determinada execução filho.

cancel_iteration(iteration)

Parâmetros

Nome Description
iteration
Obrigatório
int

A iteração a ser cancelada.

Retornos

Tipo Description

Nenhum

complete

Conclua uma execução do AutoML.

complete(**kwargs)

Retornos

Tipo Description

Nenhum

continue_experiment

Continue um experimento 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

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

Recursos de treinamento.

Valor padrão: None
y
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

Rótulos de treinamento.

Valor padrão: None
sample_weight
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

Pesos de amostra para dados de treinamento.

Valor padrão: None
X_valid
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

Recursos de validação.

Valor padrão: None
y_valid
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

Rótulos de validação.

Valor padrão: None
sample_weight_valid
DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow>

pesos de amostra do conjunto de validação.

Valor padrão: None
data
DataFrame

Rótulo e recursos de treinamento.

Valor padrão: None
label
str

Coluna de rótulo nos dados.

Valor padrão: None
columns
list(str)

Uma lista de colunas permitidas nos dados a ser usada como recursos.

Valor padrão: None
cv_splits_indices
ndarray

Indica onde dividir os dados de treinamento para validação cruzada. Cada linha é uma dobra cruzada separada e, dentro de cada dobra cruzada, são fornecidas duas matrizes, a primeira com os índices para amostras a serem usadas para dados de treinamento e a segunda com os índices a serem usados para dados de validação. ou seja, [[t1, v1], [t2, v2], ...] onde t1 são os índices de treinamento para a primeira dobra cruzada e v1 são os índices de validação para a primeira dobra cruzada.

Valor padrão: None
spark_context
<xref:SparkContext>

Contexto do Spark, aplicável somente quando usado dentro do ambiente do Azure Databricks/Spark.

Valor padrão: None
experiment_timeout_hours
float

Por quantas horas adicionais executar esse experimento.

Valor padrão: None
experiment_exit_score
int

Se especificado, indica que o experimento é encerrado quando esse valor é atingido.

Valor padrão: None
iterations
int

Quantas iterações adicionais executar para este experimento.

Valor padrão: None
show_output
bool

Sinalizador que indica se a saída deve ser impressa no console.

Valor padrão: False
training_data
<xref:azureml.dataprep.Dataflow> ou DataFrame

Dados de treinamento de entrada.

Valor padrão: None
validation_data
<xref:azureml.dataprep.Dataflow> ou DataFrame

Dados de validação.

Valor padrão: None

Retornos

Tipo Description
AutoMLRun

A executar pai do AutoML.

Exceções

Tipo Description
ConfigException
InvalidRunState

fail

Falha em uma execução do AutoML.

Há a opção de definir a propriedade de Erro 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

Nome Description
error_details
str ou BaseException

Detalhes opcionais do erro.

Valor padrão: None
error_code
str

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

Valor padrão: None
_set_status
bool

Indica se o evento de status deve ser enviado para rastreamento.

Valor padrão: True

get_best_child

Retornar a execução do filho com a melhor pontuação para essa execução do AutoML.

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

Parâmetros

Nome Description
metric
str

A métrica a ser usada ao selecionar a melhor execução a ser retornada. O padrão é a métrica primária.

Valor padrão: None
onnx_compatible

Se deve retornar apenas execuções que geraram modelos onnx.

Valor padrão: False
kwargs
Obrigatório

Retornos

Tipo Description

AutoML filho executado.

get_guardrails

Imprimir e retornar resultados detalhados da execução da verificação de Guardrail.

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

Parâmetros

Nome Description
to_console
bool

Indica se os resultados da verificação devem ser gravados no console.

Valor padrão: True

Retornos

Tipo Description
dict

Um dicionário de resultados do verificador.

Exceções

Tipo Description
UserErrorException

get_output

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

Se nenhum parâmetro de entrada for fornecido, get_output retornará o melhor pipeline de acordo com a métrica primária. Como alternativa, você pode usar o parâmetro iteration ou metric para recuperar uma iteração específica ou a melhor execução por métrica fornecida, 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

Nome Description
iteration
int

O número de iteração do modelo executado e ajustado correspondente a ser retornado.

Valor padrão: None
metric
str

A métrica a ser usada ao selecionar a melhor execução e o modelo ajustado a ser retornado.

Valor padrão: None
return_onnx_model
bool

Esse método retornará o modelo ONNX convertido se o parâmetro enable_onnx_compatible_models tiver sido definido como true no objeto AutoMLConfig.

Valor padrão: False
return_split_onnx_model
SplitOnnxModelName

O tipo do modelo de divisão onnx a ser retornado

Valor padrão: None

Retornos

Tipo Description
Run, <xref:Model>

A execução, o modelo ajustado correspondente.

Exceções

Tipo Description
ConfigException
OnnxConvertException
NotFoundException

Comentários

Se você quiser inspecionar os pré-processadores e o algoritmo (estimador) usados, poderá fazer isso por meio de Model.steps, semelhante a sklearn.pipeline.Pipeline.steps. Por exemplo, o código a seguir mostra como recuperar o estimador.


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

get_run_sdk_dependencies

Obter 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

Nome Description
iteration
int

O número de iteração da execução ajustada a ser recuperada. Se Nenhum, recuperar o ambiente pai.

Valor padrão: None
check_versions
bool

Se True, verificar as versões com o ambiente atual. Se False, passar.

Valor padrão: True

Retornos

Tipo Description
dict

O dicionário de dependências recuperado de RunHistory.

Exceções

Tipo Description
ConfigException

pause

Retornar True se a execução do AutoML tiver sido pausada com êxito.

Este método não está implementado.

pause()

Exceções

Tipo Description
NotImplementedError

register_model

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

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

Parâmetros

Nome Description
model_name
str

O nome do modelo que está sendo implantado.

Valor padrão: None
description
str

A descrição do modelo que está sendo implantado.

Valor padrão: None
tags
dict

Tags para o modelo que está sendo implantado.

Valor padrão: None
iteration
int

Substituir pelo modelo a ser implantado. Implanta o modelo para uma determinada iteração.

Valor padrão: None
metric
str

Substituir pelo modelo a ser implantado. Implanta o melhor modelo para uma métrica diferente.

Valor padrão: None

Retornos

Tipo Description
<xref:Model>

O objeto de modelo registrado.

resume

Retorna True se a execução do AutoML é retomada com êxito.

Este método não está implementado.

resume()

Exceções

Tipo Description
NotImplementedError:

retry

Retorna True se a execução do AutoML é tentada novamente com êxito.

Este método não está implementado.

retry()

Exceções

Tipo Description
NotImplementedError

summary

Obter uma tabela que contém um resumo dos algoritmos tentados e suas pontuações.

summary()

Retornos

Tipo Description
DataFrame

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

wait_for_completion

Aguardar a conclusão desta execução.

Retorna o objeto de status após a espera.

wait_for_completion(show_output=False, wait_post_processing=False)

Parâmetros

Nome Description
show_output
bool

Indica se a saída de execução deve ser mostrada em sys.stdout.

Valor padrão: False
wait_post_processing
bool

Indica se é necessário aguardar a conclusão do processamento da postagem após a conclusão da execução.

Valor padrão: False

Retornos

Tipo Description
dict

O objeto de status.

Exceções

Tipo Description
ExperimentExecutionException

Atributos

run_id

Retornar a ID de execução da execução atual.

Retornos

Tipo Description
str

A ID de executar da versão atual.