Partager via

utilities Module

  • Référence

Méthodes utilitaires pour la validation et la conversion.

Classes

suppress_stdout_stderr

Gestionnaire de contexte permettant d’effectuer une « suppression profonde » de stdout et stderr.

Supprime toute l’impression, même si elle provient d’une sous-fonction C/Fortran compilée. Ne supprime pas les exceptions levées, car les exceptions sont imprimées dans stderr juste avant la sortie d’un script et après la sortie du gestionnaire de contexte.

Créez le gestionnaire de contexte.

Functions

convert_dict_values_to_str

Convertit les valeurs d’un dictionnaire de sorte que chaque valeur soit une chaîne.

convert_dict_values_to_str(input_dict: Dict[Any, Any]) -> Dict[str, str]

Paramètres

Nom Description
input_dict
Obligatoire

dictionnaire qui doit être converti

Retours

Type Description

dictionnaire dont l’ensemble des valeurs sont converties en chaînes

get_default_metric_with_objective

Obtient le dictionnaire de métrique -> objectif de la tâche donnée.

get_default_metric_with_objective(task)

Paramètres

Nom Description
task
Obligatoire

chaîne « classification » ou « régression »

Retours

Type Description

dictionnaire de métrique -> objectif

get_error_code

Génère le code d’erreur à partir d’une exception.

get_error_code(exception: BaseException, as_hierarchy: bool = False) -> str

Paramètres

Nom Description
exception
Obligatoire

Exception qui a fait échouer l’exécution.
as_hierarchy

Si la hiérarchie d’erreurs complète doit être retournée

Valeur par défaut: False

Retours

Type Description

Retourne la chaîne contenant error_code. Si as_hierarchy a la valeur True, la hiérarchie retournée est jointe par un « . »

get_min_points

Retourne le nombre minimal de points de données nécessaires à l’entraînement.

get_min_points(window_size: int, lags: List[int], max_horizon: int, cv: int | None, n_step: int | None = None) -> int

Paramètres

Nom Description
window_size
Obligatoire

taille de la fenêtre dynamique.
lags
Obligatoire

Taille du décalage.
max_horizon
Obligatoire

longueur souhaitée des prévisions.
cv
Obligatoire

nombre de validations croisées.
n_step

Nombre de périodes entre origin_time d’un repli de validation croisée et le repli suivant. Par exemple, si n_step = 3 pour les données quotidiennes, l’heure d’origine de chaque repli sera espacée de trois jours.

Valeur par défaut: None

Retours

Type Description

nombre minimal de points de données.

get_primary_metrics

Obtient les principales métriques prises en charge pour une tâche donnée sous la forme de liste.

get_primary_metrics(task: str) -> List[str]

Paramètres

Nom Description
task
Obligatoire
str

Type de tâche pris en charge par AutoML, comme défini dans azureml.automl.core.shared.constants.Tasks

Retours

Type Description

Liste des principales métriques prises en charge pour la tâche.

get_value_float

Convertit la valeur de chaîne en valeur float. :param floatstring : valeur d’entrée à convertir. :type floatstring: str :return : valeur convertie. :rtype : float

get_value_float(floatstring: str) -> float | str | None

Paramètres

Nom Description
floatstring
Obligatoire

get_value_from_dict

Obtient la valeur d’un élément de configuration qui contient une liste de noms.

get_value_from_dict(dictionary: Dict[str, Any], names: List[str], default_value: Any) -> Any

Paramètres

Nom Description
dictionary
Obligatoire
dict

Dictionnaire de paramètres avec la paire clé-valeur pour laquelle rechercher les données.
names
Obligatoire
list[str]

Liste des noms de l’élément à rechercher.
default_value
Obligatoire

Valeur par défaut à retourner si aucune clé correspondante n’est trouvée

Retours

Type Description

Retourne la première valeur de la liste de noms.

get_value_int

Convertit la valeur de chaîne en valeur int.

get_value_int(intstring: str) -> int | str | None

Paramètres

Nom Description
intstring
Obligatoire
str

La valeur d’entrée à convertir.

Retours

Type Description
int

Valeur convertie.

interpret_exception

Traduit une exception en objet AzureMLException.

Si l’exception est déjà l’un des types connus (par exemple, ServiceException, AzureMLException), retourne l’exception en l’état.

Remarque pour les développeurs : si davantage d’exceptions ou de nouvelles interprétations sont ajoutées pour les exécutions à distance plutôt que pour les exécutions locales, envisagez de convertir cette fonctionnalité dans sa propre classe

interpret_exception(exception: BaseException, is_aml_compute: bool = True, **kwargs: Any) -> AzureMLException | ServiceException

Paramètres

Nom Description
exception
Obligatoire

Objet d’exception qui doit être interprété
is_aml_compute

Si le contexte est une exécution gérée par le service d’exécution sur un calcul AML (par exemple, OSErrors, il se peut que les erreurs de mise en réseau doivent être interprétées différemment en fonction du type d’exécution)

Valeur par défaut: True
kwargs
Obligatoire

Toutes les propriétés d’exécution attendues par ErrorDefinition (par exemple, reference_code)

Retours

Type Description

exception interprétée comme un objet AzureMLException avec le code d’erreur

is_known_date_time_format

Vérifie si une chaîne donnée correspond aux expressions régulières de date et heure connues.

is_known_date_time_format(datetime_str: str) -> bool

Paramètres

Nom Description
datetime_str
Obligatoire

Chaîne d’entrée pour vérifier s’il s’agit d’une date ou non

Retours

Type Description

Indique si la chaîne donnée est dans un format de date et heure connu ou non

minimize_or_maximize

Sélectionne l’objectif en fonction d’une mesure.

Certaines métriques doivent être minimisées et d’autres maximisées :param metric: nom de la métrique à rechercher :param task: l’un des éléments constants.Tasks. :return : retourne l’une des constantes. OptimizerObjectives.

minimize_or_maximize(metric, task=None)

Paramètres

Nom Description
metric
Obligatoire
task
Valeur par défaut: None
 
subsampling_recommended(num_samples)

Paramètres

Nom Description
num_samples
Obligatoire
int

nombre d’échantillons.

Retours

Type Description
bool

Valeur True si le sous-échantillonnage est recommandé, sinon valeur False.

to_ordinal_string

Convertit un entier en chaîne ordinale.

to_ordinal_string(integer: int) -> str

Paramètres

Nom Description
integer
Obligatoire