AutoMLRun Classe

  • Riferimento

Rappresenta un esperimento di Machine Learning automatizzato eseguito in Azure Machine Learning.

La classe AutoMLRun può essere usata per gestire un'esecuzione, controllare lo stato di esecuzione e recuperare i dettagli dell'esecuzione dopo l'invio di un'esecuzione AutoML. Per altre informazioni sull'uso delle esecuzioni dell'esperimento, vedere la Run classe .

Inizializzare un'esecuzione autoML.

Ereditarietà
Run
AutoMLRun

Costruttore

AutoMLRun(experiment, run_id, **kwargs)

Parametri

Nome Descrizione
experiment
Necessario
Experiment

Esperimento associato all'esecuzione.
run_id
Necessario
str

ID dell'esecuzione.
experiment
Necessario
Experiment

Esperimento associato all'esecuzione.
run_id
Necessario
str

ID dell'esecuzione.

Commenti

Quando si utilizza il submit metodo di un esperimento, viene restituito un oggetto AutoMLRun.

Per recuperare un'esecuzione già avviata, usare il codice seguente:


   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')

Metodi

cancel

Annullare un'esecuzione autoML.

Restituisce True se l'esecuzione di AutoML è stata annullata correttamente.
cancel_iteration

Annullare un'esecuzione figlio specifica.
complete

Completare un'esecuzione autoML.
continue_experiment

Continuare un esperimento AutoML esistente.
fail

Esito negativo di un'esecuzione autoML.

Facoltativamente, impostare la proprietà Error dell'esecuzione con un messaggio o un'eccezione passata a error_details.
get_best_child

Restituisce l'esecuzione figlio con il punteggio migliore per questa esecuzione AutoML.
get_guardrails

Stampare e restituire risultati dettagliati dall'esecuzione della verifica guardrail.
get_output

Restituisce l'esecuzione con la pipeline migliore corrispondente già testata.

Se non vengono forniti parametri di input, get_output restituisce la pipeline migliore in base alla metrica primaria. In alternativa, è possibile usare il iteration parametro o metric per recuperare una particolare iterazione o la migliore esecuzione per ogni metrica specificata.
get_run_sdk_dependencies

Ottenere le dipendenze dell'esecuzione dell'SDK per una determinata esecuzione.
pause

Restituisce True se l'esecuzione di AutoML è stata sospesa correttamente.

Questo metodo non è implementato.
register_model

Registrare il modello con il servizio AzureML ACI.
resume

Restituisce True se l'esecuzione autoML è stata ripresa correttamente.

Questo metodo non è implementato.
retry

Restituisce True se l'esecuzione di AutoML è stata ritentata correttamente.

Questo metodo non è implementato.
summary

Ottenere una tabella contenente un riepilogo degli algoritmi tentati e i relativi punteggi.
wait_for_completion

Attendere il completamento dell'esecuzione.

Restituisce l'oggetto status dopo l'attesa.

cancel

Annullare un'esecuzione autoML.

Restituisce True se l'esecuzione di AutoML è stata annullata correttamente.

cancel()

Restituisce

Tipo Descrizione

Nessuno

cancel_iteration

Annullare un'esecuzione figlio specifica.

cancel_iteration(iteration)

Parametri

Nome Descrizione
iteration
Necessario
int

Iterazione da annullare.

Restituisce

Tipo Descrizione

Nessuno

complete

Completare un'esecuzione autoML.

complete(**kwargs)

Restituisce

Tipo Descrizione

Nessuno

continue_experiment

Continuare un esperimento AutoML esistente.

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)

Parametri

Nome Descrizione
X
DataFrame oppure ndarray oppure <xref:azureml.dataprep.Dataflow>

Funzionalità di training.

Valore predefinito: None
y
DataFrame oppure ndarray oppure <xref:azureml.dataprep.Dataflow>

Etichette di training.

Valore predefinito: None
sample_weight
DataFrame oppure ndarray oppure <xref:azureml.dataprep.Dataflow>

Pesi di esempio per i dati di training.

Valore predefinito: None
X_valid
DataFrame oppure ndarray oppure <xref:azureml.dataprep.Dataflow>

Funzionalità di convalida.

Valore predefinito: None
y_valid
DataFrame oppure ndarray oppure <xref:azureml.dataprep.Dataflow>

Etichette di convalida.

Valore predefinito: None
sample_weight_valid
DataFrame oppure ndarray oppure <xref:azureml.dataprep.Dataflow>

pesi campione del set di convalida.

Valore predefinito: None
data
DataFrame

Funzionalità di training ed etichetta.

Valore predefinito: None
label
str

Etichettare la colonna nei dati.

Valore predefinito: None
columns
list(str)

Elenco di colonne consentite nei dati da usare come funzionalità.

Valore predefinito: None
cv_splits_indices
ndarray

Indici in cui suddividere i dati di training per la convalida incrociata. Ogni riga è una piega incrociata separata e all'interno di ogni crossfold, specificare 2 matrici, la prima con gli indici per i campioni da usare per i dati di training e la seconda con gli indici da usare per i dati di convalida. ad esempio [[t1, v1], [t2, v2], ...] dove t1 è gli indici di training per la prima piega incrociata e v1 è l'indice di convalida per la prima piega incrociata.

Valore predefinito: None
spark_context
<xref:SparkContext>

Contesto Spark, applicabile solo se usato all'interno dell'ambiente azure databricks/spark.

Valore predefinito: None
experiment_timeout_hours
float

Numero di ore aggiuntive per cui eseguire questo esperimento.

Valore predefinito: None
experiment_exit_score
int

Se specificato indica che l'esperimento viene terminato quando viene raggiunto questo valore.

Valore predefinito: None
iterations
int

Numero di iterazioni aggiuntive da eseguire per questo esperimento.

Valore predefinito: None
show_output
bool

Flag che indica se stampare l'output nella console.

Valore predefinito: False
training_data
<xref:azureml.dataprep.Dataflow> oppure DataFrame

Dati di training di input.

Valore predefinito: None
validation_data
<xref:azureml.dataprep.Dataflow> oppure DataFrame

Dati di convalida.

Valore predefinito: None

Restituisce

Tipo Descrizione
AutoMLRun

Esecuzione padre autoML.

Eccezioni

Tipo Descrizione
ConfigException
InvalidRunState

fail

Esito negativo di un'esecuzione autoML.

Facoltativamente, impostare la proprietà Error dell'esecuzione con un messaggio o un'eccezione passata a error_details.

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

Parametri

Nome Descrizione
error_details
str oppure BaseException

Dettagli facoltativi dell'errore.

Valore predefinito: None
error_code
str

Codice di errore facoltativo dell'errore per la classificazione degli errori.

Valore predefinito: None
_set_status
bool

Indica se inviare l'evento di stato per il rilevamento.

Valore predefinito: True

get_best_child

Restituisce l'esecuzione figlio con il punteggio migliore per questa esecuzione AutoML.

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

Parametri

Nome Descrizione
metric
str

Metrica da usare per la selezione dell'esecuzione migliore da restituire. Il valore predefinito è la metrica primaria.

Valore predefinito: None
onnx_compatible

Indica se restituire solo le esecuzioni generate dai modelli onnx.

Valore predefinito: False
kwargs
Necessario

Restituisce

Tipo Descrizione

Esecuzione figlio AutoML.

get_guardrails

Stampare e restituire risultati dettagliati dall'esecuzione della verifica guardrail.

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

Parametri

Nome Descrizione
to_console
bool

Indica se scrivere i risultati della verifica nella console.

Valore predefinito: True

Restituisce

Tipo Descrizione
dict

Dizionario dei risultati del verificatore.

Eccezioni

Tipo Descrizione
UserErrorException

get_output

Restituisce l'esecuzione con la pipeline migliore corrispondente già testata.

Se non vengono forniti parametri di input, get_output restituisce la pipeline migliore in base alla metrica primaria. In alternativa, è possibile usare il iteration parametro o metric per recuperare una particolare iterazione o la migliore esecuzione per ogni metrica specificata.

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]

Parametri

Nome Descrizione
iteration
int

Numero di iterazione dell'esecuzione corrispondente e del modello adattato da restituire.

Valore predefinito: None
metric
str

Metrica da usare per la selezione della migliore esecuzione e del modello adattato da restituire.

Valore predefinito: None
return_onnx_model
bool

Questo metodo restituirà il modello ONNX convertito se il enable_onnx_compatible_models parametro è stato impostato su True nell'oggetto AutoMLConfig .

Valore predefinito: False
return_split_onnx_model
SplitOnnxModelName

Tipo del modello split onnx da restituire

Valore predefinito: None

Restituisce

Tipo Descrizione
Run, <xref:Model>

L'esecuzione, il modello montato corrispondente.

Eccezioni

Tipo Descrizione
ConfigException
OnnxConvertException
NotFoundException

Commenti

Se si vuole controllare i preprocessori e gli algoritmi (estimator) usati, è possibile eseguire questa operazione tramite Model.steps, in modo simile a sklearn.pipeline.Pipeline.steps. Ad esempio, il codice seguente illustra come recuperare lo strumento di stima.


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

get_run_sdk_dependencies

Ottenere le dipendenze dell'esecuzione dell'SDK per una determinata esecuzione.

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

Parametri

Nome Descrizione
iteration
int

Numero di iterazione dell'esecuzione adattata da recuperare. Se Nessuno, recuperare l'ambiente padre.

Valore predefinito: None
check_versions
bool

Se True, controllare le versioni con l'ambiente corrente. Se False, passare.

Valore predefinito: True

Restituisce

Tipo Descrizione
dict

Dizionario delle dipendenze recuperate da RunHistory.

Eccezioni

Tipo Descrizione
ConfigException

pause

Restituisce True se l'esecuzione di AutoML è stata sospesa correttamente.

Questo metodo non è implementato.

pause()

Eccezioni

Tipo Descrizione
NotImplementedError

register_model

Registrare il modello con il servizio AzureML ACI.

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

Parametri

Nome Descrizione
model_name
str

Nome del modello da distribuire.

Valore predefinito: None
description
str

Descrizione del modello da distribuire.

Valore predefinito: None
tags
dict

Tag per il modello da distribuire.

Valore predefinito: None
iteration
int

Eseguire l'override per il modello da distribuire. Distribuisce il modello per una determinata iterazione.

Valore predefinito: None
metric
str

Eseguire l'override per il modello da distribuire. Distribuisce il modello migliore per una metrica diversa.

Valore predefinito: None

Restituisce

Tipo Descrizione
<xref:Model>

Oggetto modello registrato.

resume

Restituisce True se l'esecuzione autoML è stata ripresa correttamente.

Questo metodo non è implementato.

resume()

Eccezioni

Tipo Descrizione
NotImplementedError:

retry

Restituisce True se l'esecuzione di AutoML è stata ritentata correttamente.

Questo metodo non è implementato.

retry()

Eccezioni

Tipo Descrizione
NotImplementedError

summary

Ottenere una tabella contenente un riepilogo degli algoritmi tentati e i relativi punteggi.

summary()

Restituisce

Tipo Descrizione
DataFrame

DataFrame Pandas contenente le statistiche del modello AutoML.

wait_for_completion

Attendere il completamento dell'esecuzione.

Restituisce l'oggetto status dopo l'attesa.

wait_for_completion(show_output=False, wait_post_processing=False)

Parametri

Nome Descrizione
show_output
bool

Indica se visualizzare l'output dell'esecuzione in sys.stdout.

Valore predefinito: False
wait_post_processing
bool

Indica se attendere il completamento della post-elaborazione al termine dell'esecuzione.

Valore predefinito: False

Restituisce

Tipo Descrizione
dict

Oggetto status.

Eccezioni

Tipo Descrizione
ExperimentExecutionException

Attributi

run_id

Restituisce l'ID di esecuzione dell'esecuzione corrente.

Restituisce

Tipo Descrizione
str

ID esecuzione dell'esecuzione corrente.