utilities Modul
Hilfsmethoden für die Validierung und Konvertierung.
Klassen
suppress_stdout_stderr |
Ein Kontext-Manager zum Durchführen einer „umfassenden Unterdrückung doppelter Warnungen“ von „stdout“ und „stderr“. Alle Ausgaben werden unterdrückt, auch wenn diese aus einer kompilierten C/Fortran-Unterfunktion stammen. Ausgelöste Ausnahmen werden nicht unterdrückt, da Ausnahmen unmittelbar vor dem Beenden eines Skripts und nach dem Beenden des Kontext-Managers in „stderr“ ausgegeben werden. Erstellen Sie den Kontext-Manager. |
Functions
convert_dict_values_to_str
Konvertieren der Werte eines Wörterbuchs, sodass jeder Wert eine Zeichenfolge ist.
convert_dict_values_to_str(input_dict: Dict[Any, Any]) -> Dict[str, str]
Parameter
Name | Beschreibung |
---|---|
input_dict
Erforderlich
|
Das Wörterbuch, das konvertiert werden soll. |
Gibt zurück
Typ | Beschreibung |
---|---|
Ein Wörterbuch mit allen in Zeichenfolgen konvertierten Werten. |
get_default_metric_with_objective
Abrufen des Wörterbuchs der Metrik -> Ziel für die angegebene Aufgabe.
get_default_metric_with_objective(task)
Parameter
Name | Beschreibung |
---|---|
task
Erforderlich
|
Zeichenfolge „classification“ oder „regression“ |
Gibt zurück
Typ | Beschreibung |
---|---|
Wörterbuch der Metrik -> Ziel |
get_error_code
Erstellen des Fehlercodes aus einer Ausnahme.
get_error_code(exception: BaseException, as_hierarchy: bool = False) -> str
Parameter
Name | Beschreibung |
---|---|
exception
Erforderlich
|
Die Ausnahme, bei der die Ausführung fehlschlägt. |
as_hierarchy
|
Gibt an, ob die vollständige Fehlerhierarchie zurückgegeben werden soll. Standardwert: False
|
Gibt zurück
Typ | Beschreibung |
---|---|
Gibt die Zeichenfolge mit dem „error_code“ zurück. Wenn „as_hierarchy“ auf „True“ festgelegt ist, wird die zurückgegebene Hierarchie durch einen „.“ verknüpft. |
get_min_points
Dient zum Zurückgeben der mindestens erforderlichen Anzahl von Datenpunkten für das Training.
get_min_points(window_size: int, lags: List[int], max_horizon: int, cv: int | None, n_step: int | None = None) -> int
Parameter
Name | Beschreibung |
---|---|
window_size
Erforderlich
|
Die Größe des rollierenden Fensters. |
lags
Erforderlich
|
Die Verzögerungsgröße. |
max_horizon
Erforderlich
|
Die gewünschte Länge der Vorhersage. |
cv
Erforderlich
|
Die Anzahl von Kreuzvalidierungen. |
n_step
|
Die Anzahl von Zeiträumen zwischen der „origin_time“ eines Kreuzvalidierungsfolds und dem nächsten Fold. Wenn für tägliche Daten beispielsweise n_step = 3 ist, liegt die Ursprungszeit für jeden Fold drei Tage auseinander. Standardwert: None
|
Gibt zurück
Typ | Beschreibung |
---|---|
Die Mindestanzahl von Datenpunkten. |
get_primary_metrics
Abrufen einer Liste der primären Metriken, die für eine bestimmte Aufgabe unterstützt werden.
get_primary_metrics(task: str) -> List[str]
Parameter
Name | Beschreibung |
---|---|
task
Erforderlich
|
Ein vom automatisierten maschinellen Lernen unterstützter Aufgabentyp, wie in „azureml.automl.core.shared.constants.Tasks“ definiert. |
Gibt zurück
Typ | Beschreibung |
---|---|
Eine Liste der primären Metriken, die für die Aufgabe unterstützt werden. |
get_value_float
Konvertieren von Zeichenfolgenwerten in Gleitkommawerte. :param floatstring: Der zu konvertierende Eingabewert. :type floatstring: str :return: Der konvertierte Wert. :rtype: float
get_value_float(floatstring: str) -> float | str | None
Parameter
Name | Beschreibung |
---|---|
floatstring
Erforderlich
|
|
get_value_from_dict
Abrufen des Werts eines Konfigurationselements, das über eine Liste von Namen verfügt.
get_value_from_dict(dictionary: Dict[str, Any], names: List[str], default_value: Any) -> Any
Parameter
Name | Beschreibung |
---|---|
dictionary
Erforderlich
|
Wörterbuch von Einstellungen mit Schlüssel-Wert-Paaren, nach denen die Daten durchsucht werden sollen. |
names
Erforderlich
|
Die Liste der Namen für das gesuchte Element. |
default_value
Erforderlich
|
Wenn kein übereinstimmender Schlüssel gefunden wird, wird der Standardwert zurückgegeben. |
Gibt zurück
Typ | Beschreibung |
---|---|
Gibt den ersten Wert aus der Liste der Namen zurück. |
get_value_int
Konvertieren eines Zeichenfolgenwerts in eine Ganzzahl.
get_value_int(intstring: str) -> int | str | None
Parameter
Name | Beschreibung |
---|---|
intstring
Erforderlich
|
Der zu konvertierende Eingabewert. |
Gibt zurück
Typ | Beschreibung |
---|---|
Der konvertierte Wert. |
interpret_exception
Übersetzen einer Ausnahme in eine AzureMLException.
Wenn es sich um eine Ausnahme eines der bekannten Typen handelt (z. B. ServiceException, AzureMLException), wird sie unverändert zurückgegeben.
Entwicklerhinweis: Wenn weitere Ausnahmen oder neue Interpretationen für Remote- und lokale Ausführungen hinzugefügt werden, sollten Sie erwägen, diese Funktionalität in eine eigene Klasse zu konvertieren.
interpret_exception(exception: BaseException, is_aml_compute: bool = True, **kwargs: Any) -> AzureMLException | ServiceException
Parameter
Name | Beschreibung |
---|---|
exception
Erforderlich
|
Das Exception-Objekt, das interpretiert werden muss. |
is_aml_compute
|
Gibt an, ob es sich beim Kontext um die verwaltete Ausführung eines Ausführungsdiensts auf einer AML-Computeressource handelt (z. B. müssen OSErrors und Netzwerkfehler je nach Ausführungstyp möglicherweise unterschiedlich interpretiert werden). Standardwert: True
|
kwargs
Erforderlich
|
Alle Laufzeiteigenschaften, die von der ErrorDefinition erwartet werden (z. B. „reference_code“). |
Gibt zurück
Typ | Beschreibung |
---|---|
Die als AzureMLException mit Fehlercode interpretierte Ausnahme. |
is_known_date_time_format
Überprüfen, ob eine bestimmte Zeichenfolge mit den bekannten regulären Datums-/Uhrzeitausdrücken übereinstimmt.
is_known_date_time_format(datetime_str: str) -> bool
Parameter
Name | Beschreibung |
---|---|
datetime_str
Erforderlich
|
Eine Eingabezeichenfolge, für die überprüft wird, ob es sich um ein Datum handelt. |
Gibt zurück
Typ | Beschreibung |
---|---|
Gibt an, ob die angegebene Zeichenfolge in einem bekannten Datums-/Uhrzeitformat vorliegt. |
minimize_or_maximize
Auswählen des Ziels für eine Metrik.
Einige Metriken sollten minimiert und einige maximiert werden. „:param metric“: Der Name der zu suchenden Metrik. „:param task“: Eine der Aufgaben in „constants.Tasks“. „:return“: Gibt eines der Ziele in „constants.OptimizerObjectives“ zurück.
minimize_or_maximize(metric, task=None)
Parameter
Name | Beschreibung |
---|---|
metric
Erforderlich
|
|
task
|
Standardwert: None
|
subsampling_recommended
subsampling_recommended(num_samples)
Parameter
Name | Beschreibung |
---|---|
num_samples
Erforderlich
|
Die Anzahl von Stichproben. |
Gibt zurück
Typ | Beschreibung |
---|---|
„True“, wenn Subsampling empfohlen wird, andernfalls „False“. |
to_ordinal_string
Konvertieren einer ganzen Zahl in eine Ordinalzeichenfolge.
to_ordinal_string(integer: int) -> str
Parameter
Name | Beschreibung |
---|---|
integer
Erforderlich
|
|