Udostępnij przez

AutoMLRun Klasa

Reprezentuje przebieg eksperymentu zautomatyzowanego uczenia maszynowego w usłudze Azure Machine Learning.

Klasa AutoMLRun może służyć do zarządzania przebiegiem, sprawdzania stanu przebiegu i pobierania szczegółów przebiegu po przesłaniu przebiegu rozwiązania AutoML. Aby uzyskać więcej informacji na temat pracy z przebiegami eksperymentów, zobacz klasę Run .

Inicjowanie przebiegu rozwiązania AutoML.

Konstruktor

AutoMLRun(experiment, run_id, **kwargs)

Parametry

Nazwa Opis
experiment
Wymagane
Experiment

Eksperyment skojarzony z przebiegiem.
run_id
Wymagane
str

Identyfikator przebiegu.
experiment
Wymagane
Experiment

Eksperyment skojarzony z przebiegiem.
run_id
Wymagane
str

Identyfikator przebiegu.

Uwagi

Obiekt AutoMLRun jest zwracany podczas korzystania z submit metody eksperymentu.

Aby pobrać przebieg, który został już uruchomiony, użyj następującego kodu:


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

Metody

cancel

Anulowanie przebiegu rozwiązania AutoML.

Zwróć wartość True, jeśli przebieg rozwiązania AutoML został pomyślnie anulowany.
cancel_iteration

Anuluj określone uruchomienie podrzędne.
complete

Ukończ uruchamianie zautomatyzowanego uczenia maszynowego.
continue_experiment

Kontynuuj istniejący eksperyment rozwiązania AutoML.
fail

Nie można uruchomić rozwiązania AutoML.

Opcjonalnie ustaw właściwość Error przebiegu z komunikatem lub wyjątkiem przekazanym do error_details.
get_best_child

Zwróć przebieg podrzędny z najlepszym wynikiem dla tego przebiegu rozwiązania AutoML.
get_guardrails

Drukuj i zwracaj szczegółowe wyniki z uruchamiania weryfikacji guardrail.
get_output

Zwróć przebieg z odpowiednim najlepszym potokiem, który został już przetestowany.

Jeśli nie podano parametrów wejściowych, get_output zwraca najlepszy potok zgodnie z metryki podstawowej. Alternatywnie możesz użyć parametru iteration lub metric , aby pobrać określoną iterację lub najlepszy przebieg dla podanej metryki, odpowiednio.
get_run_sdk_dependencies

Pobierz zależności uruchamiania zestawu SDK dla danego przebiegu.
pause

Zwraca wartość True, jeśli przebieg rozwiązania AutoML został pomyślnie wstrzymany.

Ta metoda nie jest zaimplementowana.
register_model

Zarejestruj model w usłudze AzureML ACI.
resume

Zwróć wartość True, jeśli przebieg rozwiązania AutoML został pomyślnie wznowiony.

Ta metoda nie jest zaimplementowana.
retry

Zwraca wartość True, jeśli przebieg rozwiązania AutoML został ponowiony pomyślnie.

Ta metoda nie jest zaimplementowana.
summary

Pobierz tabelę zawierającą podsumowanie prób algorytmów i ich wyniki.
wait_for_completion

Poczekaj na ukończenie tego przebiegu.

Zwraca obiekt stanu po oczekiwaniu.

cancel

Anulowanie przebiegu rozwiązania AutoML.

Zwróć wartość True, jeśli przebieg rozwiązania AutoML został pomyślnie anulowany.

cancel()

Zwraca

Typ Opis

Żaden

cancel_iteration

Anuluj określone uruchomienie podrzędne.

cancel_iteration(iteration)

Parametry

Nazwa Opis
iteration
Wymagane
int

Iteracji do anulowania.

Zwraca

Typ Opis

Żaden

complete

Ukończ uruchamianie zautomatyzowanego uczenia maszynowego.

complete(**kwargs)

Zwraca

Typ Opis

Żaden

continue_experiment

Kontynuuj istniejący eksperyment rozwiązania AutoML.

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)

Parametry

Nazwa Opis
X
DataFrame lub ndarray lub <xref:azureml.dataprep.Dataflow>

Funkcje trenowania.

Domyślna wartość: None
y
DataFrame lub ndarray lub <xref:azureml.dataprep.Dataflow>

Etykiety treningowe.

Domyślna wartość: None
sample_weight
DataFrame lub ndarray lub <xref:azureml.dataprep.Dataflow>

Przykładowe wagi danych treningowych.

Domyślna wartość: None
X_valid
DataFrame lub ndarray lub <xref:azureml.dataprep.Dataflow>

Funkcje weryfikacji.

Domyślna wartość: None
y_valid
DataFrame lub ndarray lub <xref:azureml.dataprep.Dataflow>

Etykiety weryfikacji.

Domyślna wartość: None
sample_weight_valid
DataFrame lub ndarray lub <xref:azureml.dataprep.Dataflow>

wagi próbek zestawu sprawdzania poprawności.

Domyślna wartość: None
data
DataFrame

Funkcje i etykieta szkoleniowa.

Domyślna wartość: None
label
str

Etykieta kolumny w danych.

Domyślna wartość: None
columns
list(str)

Lista dozwolonych kolumn w danych, które mają być używane jako funkcje.

Domyślna wartość: None
cv_splits_indices
ndarray

Indeksy, w których należy podzielić dane treningowe na potrzeby krzyżowej weryfikacji. Każdy wiersz jest oddzielnym krzyżowym fałdem i w każdym skrzyżowaniu, udostępnia 2 tablice, pierwszy z indeksami przykładów do użycia na potrzeby danych szkoleniowych, a drugi z indeksami używanymi do sprawdzania poprawności danych. tj. [[t1, v1], [t2, v2], ...], gdzie t1 to indeksy treningowe dla pierwszego składania krzyżowego, a v1 to indeksy walidacji dla pierwszego krzyżowego składania.

Domyślna wartość: None
spark_context
<xref:SparkContext>

Kontekst platformy Spark ma zastosowanie tylko wtedy, gdy jest używany w środowisku usługi Azure Databricks/spark.

Domyślna wartość: None
experiment_timeout_hours
float

Ile dodatkowych godzin należy uruchomić dla tego eksperymentu.

Domyślna wartość: None
experiment_exit_score
int

Jeśli określono, oznacza to, że eksperyment zostanie zakończony po osiągnięciu tej wartości.

Domyślna wartość: None
iterations
int

Ile dodatkowych iteracji należy uruchomić dla tego eksperymentu.

Domyślna wartość: None
show_output
bool

Flaga wskazująca, czy wyświetlić dane wyjściowe w konsoli.

Domyślna wartość: False
training_data
<xref:azureml.dataprep.Dataflow> lub DataFrame

Dane wejściowe trenowania.

Domyślna wartość: None
validation_data
<xref:azureml.dataprep.Dataflow> lub DataFrame

Dane weryfikacji.

Domyślna wartość: None

Zwraca

Typ Opis
AutoMLRun

Uruchomienie nadrzędnego rozwiązania AutoML.

Wyjątki

Typ Opis
ConfigException
InvalidRunState

fail

Nie można uruchomić rozwiązania AutoML.

Opcjonalnie ustaw właściwość Error przebiegu z komunikatem lub wyjątkiem przekazanym do error_details.

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

Parametry

Nazwa Opis
error_details
str lub BaseException

Opcjonalne szczegóły błędu.

Domyślna wartość: None
error_code
str

Opcjonalny kod błędu dla klasyfikacji błędów.

Domyślna wartość: None
_set_status
bool

Wskazuje, czy zdarzenie stanu ma być wysyłane do śledzenia.

Domyślna wartość: True

get_best_child

Zwróć przebieg podrzędny z najlepszym wynikiem dla tego przebiegu rozwiązania AutoML.

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

Parametry

Nazwa Opis
metric
str

Metryka do użycia podczas wybierania najlepszego przebiegu do zwrócenia. Domyślnie jest to metryka podstawowa.

Domyślna wartość: None
onnx_compatible

Czy zwracać mają być tylko uruchomienia wygenerowane przez modele onnx.

Domyślna wartość: False
kwargs
Wymagane

Zwraca

Typ Opis

Uruchamianie podrzędne rozwiązania AutoML.

get_guardrails

Drukuj i zwracaj szczegółowe wyniki z uruchamiania weryfikacji guardrail.

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

Parametry

Nazwa Opis
to_console
bool

Wskazuje, czy zapisać wyniki weryfikacji w konsoli programu .

Domyślna wartość: True

Zwraca

Typ Opis
dict

Słownik wyników weryfikatora.

Wyjątki

Typ Opis
UserErrorException

get_output

Zwróć przebieg z odpowiednim najlepszym potokiem, który został już przetestowany.

Jeśli nie podano parametrów wejściowych, get_output zwraca najlepszy potok zgodnie z metryki podstawowej. Alternatywnie możesz użyć parametru iteration lub metric , aby pobrać określoną iterację lub najlepszy przebieg dla podanej metryki, odpowiednio.

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]

Parametry

Nazwa Opis
iteration
int

Numer iteracji odpowiedniego przebiegu i dopasowanego modelu do zwrócenia.

Domyślna wartość: None
metric
str

Metryka do użycia podczas wybierania najlepszego przebiegu i dopasowanego modelu do zwrócenia.

Domyślna wartość: None
return_onnx_model
bool

Ta metoda zwróci przekonwertowany model ONNX, jeśli enable_onnx_compatible_models parametr został ustawiony na wartość True w AutoMLConfig obiekcie.

Domyślna wartość: False
return_split_onnx_model
SplitOnnxModelName

Typ modelu onnx podziału, który ma być zwracany

Domyślna wartość: None

Zwraca

Typ Opis
Run, <xref:Model>

Przebieg, odpowiedni dopasowany model.

Wyjątki

Typ Opis
ConfigException
OnnxConvertException
NotFoundException

Uwagi

Jeśli chcesz sprawdzić używane preprocesory i algorytm (narzędzie do szacowania), możesz to zrobić za pomocą Model.stepsmetody , podobnej do sklearn.pipeline.Pipeline.steps. Na przykład poniższy kod pokazuje, jak pobrać narzędzie do szacowania.


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

get_run_sdk_dependencies

Pobierz zależności uruchamiania zestawu SDK dla danego przebiegu.

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

Parametry

Nazwa Opis
iteration
int

Numer iteracji dopasowanego przebiegu do pobrania. Jeśli brak, pobierz środowisko nadrzędne.

Domyślna wartość: None
check_versions
bool

Jeśli wartość True, sprawdź wersje w bieżącym środowisku. Jeśli fałsz, przekaż.

Domyślna wartość: True

Zwraca

Typ Opis
dict

Słownik zależności pobrany z elementu RunHistory.

Wyjątki

Typ Opis
ConfigException

pause

Zwraca wartość True, jeśli przebieg rozwiązania AutoML został pomyślnie wstrzymany.

Ta metoda nie jest zaimplementowana.

pause()

Wyjątki

Typ Opis
NotImplementedError

register_model

Zarejestruj model w usłudze AzureML ACI.

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

Parametry

Nazwa Opis
model_name
str

Nazwa wdrażanego modelu.

Domyślna wartość: None
description
str

Opis wdrażanego modelu.

Domyślna wartość: None
tags
dict

Tagi dla wdrażanego modelu.

Domyślna wartość: None
iteration
int

Zastąpij model do wdrożenia. Wdraża model dla danej iteracji.

Domyślna wartość: None
metric
str

Zastąpij model do wdrożenia. Wdraża najlepszy model dla innej metryki.

Domyślna wartość: None

Zwraca

Typ Opis
<xref:Model>

Zarejestrowany obiekt modelu.

resume

Zwróć wartość True, jeśli przebieg rozwiązania AutoML został pomyślnie wznowiony.

Ta metoda nie jest zaimplementowana.

resume()

Wyjątki

Typ Opis
NotImplementedError:

retry

Zwraca wartość True, jeśli przebieg rozwiązania AutoML został ponowiony pomyślnie.

Ta metoda nie jest zaimplementowana.

retry()

Wyjątki

Typ Opis
NotImplementedError

summary

Pobierz tabelę zawierającą podsumowanie prób algorytmów i ich wyniki.

summary()

Zwraca

Typ Opis
DataFrame

Ramka danych Biblioteki Pandas zawierająca statystyki modelu AutoML.

wait_for_completion

Poczekaj na ukończenie tego przebiegu.

Zwraca obiekt stanu po oczekiwaniu.

wait_for_completion(show_output=False, wait_post_processing=False)

Parametry

Nazwa Opis
show_output
bool

Wskazuje, czy mają być wyświetlane dane wyjściowe przebiegu w pliku sys.stdout.

Domyślna wartość: False
wait_post_processing
bool

Wskazuje, czy poczekać na zakończenie przetwarzania po zakończeniu przebiegu.

Domyślna wartość: False

Zwraca

Typ Opis
dict

Obiekt stanu.

Wyjątki

Typ Opis
ExperimentExecutionException

Atrybuty

run_id

Zwróć identyfikator przebiegu bieżącego przebiegu.

Zwraca

Typ Opis
str

Identyfikator przebiegu bieżącego przebiegu.