AutoMLRun Classe

Représente une exécution d’expérience ML automatisée dans Azure Machine Learning.

La classe AutoMLRun peut être utilisée pour gérer une exécution, vérifier l’état de l’exécution et récupérer les détails de l’exécution une fois qu’une exécution AutoML est envoyée. Pour plus d’informations sur l’utilisation des exécutions d’expériences, consultez la Run classe.

Initialisez une exécution AutoML.

Constructeur

AutoMLRun(experiment, run_id, **kwargs)

Paramètres

Nom	Description
experiment Obligatoire	Experiment Expérience associée à l’exécution.
run_id Obligatoire	str ID de l’exécution.
experiment Obligatoire	Experiment Expérience associée à l’exécution.
run_id Obligatoire	str ID de l’exécution.

Remarques

Un objet AutoMLRun est retourné lorsque vous utilisez la submit méthode d’une expérience.

Pour récupérer une exécution qui a déjà démarré, utilisez le code suivant :


   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éthodes

cancel	Annulez une exécution AutoML. Retourne la valeur True si l’exécution AutoML a été annulée avec succès.
cancel_iteration	Annulez une exécution enfant particulière.
complete	Terminez une exécution AutoML.
continue_experiment	Poursuivez une expérience AutoML existante.
fail	Échec d’une exécution AutoML. Définissez éventuellement la propriété Error de l’exécution avec un message ou une exception passé à `error_details`.
get_best_child	Retournez l’exécution enfant avec le meilleur score pour cette exécution AutoML.
get_guardrails	Imprimez et retournez les résultats détaillés de l’exécution de la vérification guardrail.
get_output	Retournez l’exécution avec le meilleur pipeline correspondant qui a déjà été testé. Si aucun paramètre d’entrée n’est fourni, `get_output` retourne le meilleur pipeline en fonction de la métrique principale. Vous pouvez également utiliser le ou `iteration` le `metric` paramètre pour récupérer une itération particulière ou la meilleure exécution par métrique fournie, respectivement.
get_run_sdk_dependencies	Obtenez les dépendances d’exécution du Kit de développement logiciel (SDK) pour une exécution donnée.
pause	Retourne la valeur True si l’exécution AutoML a été suspendue correctement. Cette méthode n’est pas implémentée.
register_model	Inscrivez le modèle auprès du service ACI AzureML.
resume	Retourne la valeur True si l’exécution AutoML a été reprise avec succès. Cette méthode n’est pas implémentée.
retry	Retourne la valeur True si l’exécution AutoML a été retentée correctement. Cette méthode n’est pas implémentée.
summary	Obtenez une table contenant un résumé des algorithmes tentés et leurs scores.
wait_for_completion	Attendez la fin de cette exécution. Retourne l’objet d’état après l’attente.

cancel

Annulez une exécution AutoML.

Retourne la valeur True si l’exécution AutoML a été annulée avec succès.

cancel()

Retours

Type	Description
	Aucun

cancel_iteration

Annulez une exécution enfant particulière.

cancel_iteration(iteration)

Paramètres

Nom	Description
iteration Obligatoire	int Itération à annuler.

Retours

Type	Description
	Aucun

complete

Terminez une exécution AutoML.

complete(**kwargs)

Retours

Type	Description
	Aucun

continue_experiment

Poursuivez une expérience AutoML existante.

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)

Paramètres

Nom	Description
X	DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow> Fonctionnalités de formation. Valeur par défaut: None
y	DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow> Étiquettes d’entraînement. Valeur par défaut: None
sample_weight	DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow> Poids des exemples pour les données d’entraînement. Valeur par défaut: None
X_valid	DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow> Fonctionnalités de validation. Valeur par défaut: None
y_valid	DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow> Étiquettes de validation. Valeur par défaut: None
sample_weight_valid	DataFrame ou ndarray ou <xref:azureml.dataprep.Dataflow> poids des exemples de jeu de validation. Valeur par défaut: None
data	DataFrame Fonctionnalités et étiquettes de formation. Valeur par défaut: None
label	str Colonne d’étiquette dans les données. Valeur par défaut: None
columns	list(str) Liste des colonnes autorisées dans les données à utiliser en tant que fonctionnalités. Valeur par défaut: None
cv_splits_indices	ndarray Index où fractionner les données d’apprentissage pour la validation croisée. Chaque ligne est un pli croisé distinct et dans chaque interfold, fournit 2 tableaux, le premier avec les index pour les échantillons à utiliser pour les données d’apprentissage et le second avec les index à utiliser pour les données de validation. c’est-à-dire [[t1, v1], [t2, v2], ...] où t1 est les indices d’entraînement pour le premier repli croisé et v1 est les indices de validation pour le premier pli croisé. Valeur par défaut: None
spark_context	<xref:SparkContext> Contexte Spark, applicable uniquement lorsqu’il est utilisé dans un environnement Azure databricks/spark. Valeur par défaut: None
experiment_timeout_hours	float Combien d’heures supplémentaires pour exécuter cette expérience. Valeur par défaut: None
experiment_exit_score	int Si spécifié indique que l’expérience est terminée lorsque cette valeur est atteinte. Valeur par défaut: None
iterations	int Nombre d’itérations supplémentaires à exécuter pour cette expérience. Valeur par défaut: None
show_output	bool Indicateur indiquant s’il faut imprimer la sortie dans la console. Valeur par défaut: False
training_data	<xref:azureml.dataprep.Dataflow> ou DataFrame Données d’apprentissage d’entrée. Valeur par défaut: None
validation_data	<xref:azureml.dataprep.Dataflow> ou DataFrame Données de validation. Valeur par défaut: None

Retours

Type	Description
AutoMLRun	Exécution parente AutoML.

Exceptions

Type	Description
ConfigException
InvalidRunState

fail

Échec d’une exécution AutoML.

Définissez éventuellement la propriété Error de l’exécution avec un message ou une exception passé à error_details.

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

Paramètres

Nom	Description
error_details	str ou BaseException Détails facultatifs de l’erreur. Valeur par défaut: None
error_code	str Code d’erreur facultatif de l’erreur pour la classification des erreurs. Valeur par défaut: None
_set_status	bool Indique s’il faut envoyer l’événement d’état pour le suivi. Valeur par défaut: True

get_best_child

Retournez l’exécution enfant avec le meilleur score pour cette exécution AutoML.

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

Paramètres

Nom	Description
metric	str Métrique à utiliser lors de la sélection de la meilleure exécution à retourner. La valeur par défaut est la métrique principale. Valeur par défaut: None
onnx_compatible	Indique s’il faut retourner uniquement des exécutions qui ont généré des modèles onnx. Valeur par défaut: False
kwargs Obligatoire

Retours

Type	Description
	Exécution enfant AutoML.

get_guardrails

Imprimez et retournez les résultats détaillés de l’exécution de la vérification guardrail.

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

Paramètres

Nom	Description
to_console	bool Indique s’il faut écrire les résultats de la vérification dans la console. Valeur par défaut: True

Retours

Type	Description
dict	Dictionnaire des résultats du vérificateur.

Exceptions

Type	Description
UserErrorException

get_output

Retournez l’exécution avec le meilleur pipeline correspondant qui a déjà été testé.

Si aucun paramètre d’entrée n’est fourni, get_output retourne le meilleur pipeline en fonction de la métrique principale. Vous pouvez également utiliser le ou iteration le metric paramètre pour récupérer une itération particulière ou la meilleure exécution par métrique fournie, respectivement.

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]

Paramètres

Nom	Description
iteration	int Numéro d’itération de l’exécution correspondante et modèle ajusté à retourner. Valeur par défaut: None
metric	str Métrique à utiliser lors de la sélection du modèle le mieux exécuté et adapté à retourner. Valeur par défaut: None
return_onnx_model	bool Cette méthode retourne le modèle ONNX converti si le `enable_onnx_compatible_models` paramètre a été défini sur True dans l’objet AutoMLConfig . Valeur par défaut: False
return_split_onnx_model	SplitOnnxModelName Type du modèle onnx fractionné à retourner Valeur par défaut: None

Retours

Type	Description
Run, <xref:Model>	L’exécution, le modèle ajusté correspondant.

Exceptions

Type	Description
ConfigException
OnnxConvertException
NotFoundException

Remarques

Si vous souhaitez inspecter le ou les préprocesseurs et l’algorithme (estimateur) utilisés, vous pouvez le faire via Model.steps, similaire à sklearn.pipeline.Pipeline.steps. Par exemple, le code ci-dessous montre comment récupérer l’estimateur.


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

get_run_sdk_dependencies

Obtenez les dépendances d’exécution du Kit de développement logiciel (SDK) pour une exécution donnée.

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

Paramètres

Nom	Description
iteration	int Numéro d’itération de l’exécution adaptée à récupérer. Si aucun, récupérez l’environnement parent. Valeur par défaut: None
check_versions	bool Si la valeur est True, vérifiez les versions avec l’environnement actuel. Si la valeur est False, passez. Valeur par défaut: True

Retours

Type	Description
dict	Dictionnaire des dépendances récupérées à partir de RunHistory.

Exceptions

Type	Description
ConfigException

pause

Retourne la valeur True si l’exécution AutoML a été suspendue correctement.

Cette méthode n’est pas implémentée.

pause()

Exceptions

Type	Description
NotImplementedError

register_model

Inscrivez le modèle auprès du service ACI AzureML.

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

Paramètres

Nom	Description
model_name	str Nom du modèle en cours de déploiement. Valeur par défaut: None
description	str Description du modèle en cours de déploiement. Valeur par défaut: None
tags	dict Balises pour le modèle en cours de déploiement. Valeur par défaut: None
iteration	int Remplacez le modèle à déployer. Déploie le modèle pour une itération donnée. Valeur par défaut: None
metric	str Remplacez le modèle à déployer. Déploie le meilleur modèle pour une métrique différente. Valeur par défaut: None

Retours

Type	Description
<xref:Model>	Objet de modèle inscrit.

resume

Retourne la valeur True si l’exécution AutoML a été reprise avec succès.

Cette méthode n’est pas implémentée.

resume()

Exceptions

Type	Description
NotImplementedError:

retry

Retourne la valeur True si l’exécution AutoML a été retentée correctement.

Cette méthode n’est pas implémentée.

retry()

Exceptions

Type	Description
NotImplementedError

summary

Obtenez une table contenant un résumé des algorithmes tentés et leurs scores.

summary()

Retours

Type	Description
DataFrame	DataFrame Pandas contenant des statistiques de modèle AutoML.

wait_for_completion

Attendez la fin de cette exécution.

Retourne l’objet d’état après l’attente.

wait_for_completion(show_output=False, wait_post_processing=False)

Paramètres

Nom	Description
show_output	bool Indique s’il faut afficher la sortie d’exécution sur sys.stdout. Valeur par défaut: False
wait_post_processing	bool Indique s’il faut attendre la fin du post-traitement une fois l’exécution terminée. Valeur par défaut: False

Retours

Type	Description
dict	Objet d’état.

Exceptions

Type	Description
ExperimentExecutionException

Attributs

run_id

Retourne l’ID d’exécution de l’exécution actuelle.

Retours

Type	Description
str	ID d’exécution de l’exécution actuelle.

Commentaires

Cette page a-t-elle été utile ?