Run Klasa

Definiuje klasę bazową dla wszystkich Azure Machine Learningych przebiegów eksperymentów.

Przebieg reprezentuje pojedynczą wersję próbną eksperymentu. Uruchomienia są używane do monitorowania asynchronicznego wykonywania wersji próbnej, rejestrowania metryk i przechowywania danych wyjściowych wersji próbnej oraz do analizowania wyników i uzyskiwania dostępu do artefaktów wygenerowanych przez wersję próbną.

Obiekty Run są tworzone podczas przesyłania skryptu w celu uczenia modelu w wielu różnych scenariuszach w Azure Machine Learning, w tym uruchamiania na dyskach, uruchomieniach potoków i AutoML. Obiekt Run jest również tworzony podczas submit lub start_logging z Experiment klasą.

Aby rozpocząć pracę z eksperymentami i uruchomieniami, zobacz

Dziedziczenie
azureml._run_impl.run_base._RunBase
Run

Konstruktor

Run(experiment, run_id, outputs=None, **kwargs)

Parametry

experiment
Experiment

Zawierający eksperyment.

run_id
str

Identyfikator uruchomienia.

outputs
str

Dane wyjściowe do śledzenia.

_run_dto
<xref:azureml._restclient.models.run_dto.RunDto>

Tylko do użytku wewnętrznego.

kwargs
dict

Słownik dodatkowych parametrów konfiguracji.

Uwagi

Przebieg reprezentuje pojedynczą wersję próbną eksperymentu. Obiekt run służy do monitorowania asynchronicznego wykonywania wersji próbnej, rejestrowania metryk i przechowywania danych wyjściowych wersji próbnej oraz do analizowania wyników i uzyskiwania dostępu do artefaktów wygenerowanych przez wersję próbną.

Przebieg jest używany wewnątrz kodu eksperymentu w celu rejestrowania metryk i artefaktów w usłudze historii uruchamiania.

Przebieg jest używany poza eksperymentami w celu monitorowania postępu oraz wykonywania zapytań i analizowania wygenerowanych metryk i wyników.

Funkcja Run obejmuje następujące funkcje:

  • Przechowywanie i pobieranie metryk i danych

  • Przekazywanie i pobieranie plików

  • Używanie tagów oraz hierarchii podrzędnej w celu łatwego wyszukiwania przeszłych uruchomień

  • Rejestrowanie przechowywanych plików modelu jako modelu, który może być funkcjonujący

  • Przechowywanie, modyfikowanie i pobieranie właściwości przebiegu

  • Ładowanie bieżącego przebiegu ze środowiska zdalnego przy użyciu get_context metody

  • Wydajne snapshotting pliku lub katalogu w celu uzyskania odtwarzalności

Ta klasa współdziała z Experiment następującymi scenariuszami:

  • Tworzenie przebiegu przez wykonanie kodu przy użyciu submit

  • Interaktywna Tworzenie przebiegu w notesie przy użyciu start_logging

  • Rejestrowanie metryk i przekazywanie artefaktów w eksperymentie, na przykład podczas korzystania z log

  • Odczytywanie metryk i pobieranie artefaktów podczas analizowania eksperymentalnych wyników, na przykład podczas korzystania z get_metrics

Aby przesłać przebieg, Utwórz obiekt konfiguracji, który opisuje, jak działa eksperyment. Poniżej przedstawiono przykłady różnych obiektów konfiguracji, których można użyć:

Następujące metryki można dodać do przebiegu podczas uczenia eksperymentu.

  • Funkcja

    • Rejestruj wartość liczbową lub ciągu do przebiegu o podaną nazwę przy użyciu log . Zarejestrowanie metryki w przebiegu powoduje, że Metryka jest przechowywana w rekordzie uruchomienia w eksperymentie. Tę samą metrykę można rejestrować wiele razy w ramach przebiegu, dlatego wynik jest uznawany za wektor tej metryki.

    • Przykład: run.log("accuracy", 0.95)

  • Lista

    • Rejestruj listę wartości do uruchomienia o podanej nazwie przy użyciu log_list .

    • Przykład: run.log_list("accuracies", [0.6, 0.7, 0.87])

  • Wiersz

    • Użycie log_row tworzy metrykę z wieloma kolumnami zgodnie z opisem w temacie kwargs . Każdy nazwany parametr generuje kolumnę o określonej wartości. log_row może być wywoływana raz, aby zarejestrować dowolną spójność lub wiele razy w pętli w celu wygenerowania kompletnej tabeli.

    • Przykład: run.log_row("Y over X", x=1, y=0.4)

  • Tabela

    • Rejestruj obiekt słownika do uruchomienia o podaną nazwę przy użyciu log_table .

    • Przykład: run.log_table("Y over X", {"x":[1, 2, 3], "y":[0.6, 0.7, 0.89]})

  • Obraz

    • Rejestruj obraz do rekordu uruchomienia. Służy log_image do rejestrowania pliku obrazu lub wykresu matplotlib do uruchomienia. Te obrazy będą widoczne i porównywalne w rekordzie uruchomienia.

    • Przykład: run.log_image("ROC", path)

Metody

add_properties

Dodaj niezmienne właściwości do przebiegu.

Tagi i właściwości (zarówno DICT [str, str]) różnią się w ich zmienność. Właściwości są niezmienne, więc tworzą stałe rekordy do celów inspekcji. Tagi są modyfikowalne. Aby uzyskać więcej informacji na temat pracy ze znacznikami i właściwościami, zobacz uruchamianie tagów i znajdowanie.

add_type_provider

Element Hook rozszerzalności dla niestandardowych typów przebiegów przechowywanych w historii uruchamiania.

cancel

Oznacz Uruchom jako anulowane.

Jeśli istnieje skojarzone zadanie z określonym polem cancel_uri, Przerwij to zadanie.

child_run

Utwórz uruchomienie podrzędne.

clean

Usuń pliki odpowiadające bieżącemu przebiegowi w miejscu docelowym określonym w konfiguracji przebiegu.

complete

Poczekaj na przetworzenie kolejki zadań.

Następnie uruchomienie jest oznaczone jako ukończone. Jest to zwykle używane w scenariuszach interaktywnego notesu.

create_children

Utwórz jeden lub wiele uruchomień podrzędnych.

download_file

Pobierz skojarzony plik z magazynu.

download_files

Pobierz pliki z danego prefiksu (nazwy folderu) lub całego kontenera, jeśli prefiks jest nieokreślony.

fail

Przestarzałe. Użyj <xref:azureml.core.run.tag> , aby oznaczyć przebieg jako zakończony niepowodzeniem lub użyć, cancel Aby oznaczyć Uruchom jako anulowane.

Oznacz przebieg jako zakończony niepowodzeniem.

Opcjonalnie można ustawić właściwość błędu przebiegu z komunikatem lub wyjątek przekazaną do error_details .

flush

Poczekaj na przetworzenie kolejki zadań.

get

Pobierz przebieg dla tego obszaru roboczego z IDENTYFIKATORem jego przebiegu.

get_all_logs

Pobierz wszystkie dzienniki dla uruchomienia do katalogu.

get_children

Pobierz wszystkie elementy podrzędne dla bieżącego przebiegu wybranego przez określone filtry.

get_context

Zwróć bieżący kontekst usługi.

Użyj tej metody, aby pobrać bieżący kontekst usługi na potrzeby rejestrowania metryk i przekazywania plików. Jeśli allow_offline wartość jest równa true (domyślnie), akcje względem obiektu Run zostaną wydrukowane do warstwy Standardowa.

get_detailed_status

Pobierz najnowszy stan przebiegu. Jeśli stan uruchomienia to "w kolejce", zostaną wyświetlone szczegóły.

get_details

Pobierz definicję, informacje o stanie, bieżące pliki dziennika i inne szczegóły przebiegu.

get_details_with_logs

Zwróć stan uruchomienia wraz z zawartością pliku dziennika.

get_environment

Pobierz definicję środowiska, która była używana w tym przebiegu.

get_file_names

Wyświetl listę plików, które są przechowywane w skojarzeniu z przebiegiem.

get_metrics

Pobierz metryki zarejestrowane do uruchomienia.

Jeśli recursive ma wartość true (domyślnie false), a następnie pobierze metryki dla przebiegów w poddrzewie danego uruchomienia.

get_properties

Pobierz najnowsze właściwości przebiegu z usługi.

get_secret

Pobierz wartość klucza tajnego z kontekstu uruchomienia.

Pobierz wartość wpisu tajnego dla podanej nazwy. Nazwa wpisu tajnego odwołuje się do wartości przechowywanej w Azure Key Vault skojarzonej z obszarem roboczym. Przykład pracy z wpisami tajnymi można znaleźć w temacie Korzystanie z wpisów tajnych w programie szkoleniowym.

get_secrets

Pobierz wartości tajne dla danej listy nazw wpisów tajnych.

Pobierz słownik znalezionych i nieznalezionych wpisów tajnych dla listy podanych nazw. Każda nazwa klucza tajnego odwołuje się do wartości przechowywanej w Azure Key Vault skojarzonej z obszarem roboczym. Przykład pracy z wpisami tajnymi można znaleźć w temacie Korzystanie z wpisów tajnych w programie szkoleniowym.

get_snapshot_id

Pobierz najnowszy identyfikator migawki.

get_status

Pobierz najnowszy stan przebiegu.

Zwrócone wartości są następujące: "uruchomiona", "ukończone" i "Niepowodzenie".

get_submitted_run

Przestarzałe. Użyj polecenia get_context.

Pobierz przesłany przebieg dla tego eksperymentu.

get_tags

Pobierz najnowszy zestaw modyfikowalnych tagów w przebiegu z usługi.

list

Pobierz listę przebiegów w ramach eksperymentu określonego przez filtry opcjonalne.

list_by_compute

Pobierz listę przebiegów w ramach obliczeń określonych przez opcjonalne filtry.

log

Rejestruj wartość metryki do uruchomienia o podaną nazwę.

log_accuracy_table

Rejestruj tabelę dokładności do magazynu artefaktów.

Metryka tabeli dokładności jest metryką wielokrotnego użytku, która nie jest skalarna, która może służyć do tworzenia wielu typów wykresów liniowych, które zmieniają się w sposób ciągły w miejscu przewidywanych prawdopodobieństw. Przykłady tych wykresów to ROC, Precision-Call i unieś krzywe.

Obliczenie tabeli dokładności jest podobne do obliczenia krzywej ROC. Krzywa ROC przechowuje prawdziwe dodatnie stawki i fałszywie dodatnie stawki dla wielu różnych progów prawdopodobieństwa. W tabeli dokładności przechowywane są nieprzetworzone liczby dodatnie pozytywne, fałszywe dodatnie, prawdziwe ujemne i fałszywe wartości ujemne z wieloma progami prawdopodobieństwa.

Istnieją dwie metody używane do wybierania progów: "prawdopodobieństwo" i "percentyl". Różnią się one sposobem próbkowania od miejsca przewidywanych prawdopodobieństw.

Progi prawdopodobieństwa są równomiernie rozmieszczone progi z zakresu od 0 do 1. Jeśli NUM_POINTS wynosi 5 progi prawdopodobieństwa byłyby [0,0, 0,25, 0,5, 0,75, 1,0].

Progi percentylu są rozjmowane w zależności od rozkładu przewidywanych prawdopodobieństw. Każdy próg odnosi się do percentylu danych przy progu prawdopodobieństwa. Na przykład jeśli NUM_POINTS ma wartość 5, pierwszy próg będzie 0th percentyl, drugi o 25 percentyl, trzeci w pięćdziesiąt i tak dalej.

Tabele prawdopodobieństwa i tabele percentylu są listami 3W, w których pierwszy wymiar reprezentuje etykietę klasy, drugi wymiar reprezentuje próbkę z jednym progiem (skaluje się NUM_POINTS), a trzeci wymiar zawsze ma 4 wartości: TP, FP, TN, FN i zawsze w tej kolejności.

Wartości niepomylene (TP, FP, TN, FN) są obliczane przy użyciu jednej strategii a. Rest. Aby uzyskać więcej informacji, zobacz następujący link: https://en.wikipedia.org/wiki/Multiclass_classification

N = liczba próbek w zestawie danych walidacji (200 w przykładzie) M = # Threshold = # próbek pobranych z przestrzeni prawdopodobieństwa (5 na przykład) C = # klas w pełnym zestawie danych (3 na przykład)

Niektóre niewarianty tabeli dokładności:

  • TP + FP + TN + FN = N dla wszystkich progów dla wszystkich klas
  • TP + FN jest taka sama dla wszystkich progów dla każdej klasy
  • TN + FP jest taka sama dla wszystkich progów dla każdej klasy
  • Tabele prawdopodobieństwa i tabele percentylu mają kształt [C, M, 4]

Uwaga: M może być dowolną wartością i kontroluje rozdzielczość wykresów, ponieważ jest ona niezależna od zestawu danych, jest definiowana podczas obliczania metryk i handlu poza miejscem do magazynowania, czasem obliczeniowym i rozdzielczością.

Etykiety klas powinny być ciągami, dlatego wartości niepomylene powinny być liczbami całkowitymi, a wartości progowe powinny być zmiennoprzecinkowe.

log_confusion_matrix

Rejestruj niepomyleną macierz do magazynu artefaktów.

Spowoduje to zarejestrowanie otoki wokół skryptu sklearn niemylenej macierzy. Dane metryki zawierają etykiety klas i listę 2D dla samej macierzy. Aby uzyskać więcej informacji na temat obliczania metryki, zobacz następujący link: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html

log_image

Rejestruj metrykę obrazu do rekordu uruchomienia.

log_list

Rejestruj listę wartości metryk do uruchomienia o podanej nazwie.

log_predictions

Rejestruj przewidywania do magazynu artefaktów.

To rejestruje ocenę metryki, która może służyć do porównywania rozkładów prawdziwych wartości docelowych do dystrybucji prognozowanych wartości dla zadania regresji.

Przewidywania to Binned, a standardowe odchylenia są obliczane dla słupków błędów na wykresie liniowym.

log_residuals

Rejestruje reszty w magazynie artefaktów.

To rejestruje dane, które są konieczne do wyświetlenia histogramu reszty dla zadania regresji. Reszty są przewidywane w rzeczywistości.

Powinna istnieć jeszcze jedna krawędź niż liczba. Zapoznaj się z dokumentacją histogramu numpy, aby poznać przykłady użycia liczników i krawędzi do reprezentowania histogramu. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html

log_row

Rejestruj metrykę wiersza do uruchomienia o podaną nazwę.

log_table

Rejestruj metrykę tabeli do uruchomienia o podaną nazwę.

register_model

Zarejestruj model dla operacjonalizacji.

remove_tags

Usuń listę modyfikowalnych tagów w tym przebiegu.

restore_snapshot

Przywróć migawkę jako plik ZIP. Zwraca ścieżkę do pliku ZIP.

set_tags

Dodawanie lub modyfikowanie zestawu tagów w przebiegu. Tagi, które nie są przenoszone w słowniku, są pozostawione w niezmienionej postaci.

Możesz również dodać proste Tagi ciągu. Gdy Tagi są wyświetlane w słowniku tagów jako klucze, mają wartość none. Aby uzyskać więcej informacji, zobacz Tagi i Znajdź uruchomienia.

start

Oznacz przebieg jako uruchomiony.

Jest to zwykle używane w zaawansowanych scenariuszach, gdy przebieg został utworzony przez innego aktora.

submit_child

Przesyłanie eksperymentu i powrót do aktywnego przebiegu podrzędnego.

tag

Oznacz przebieg z kluczem ciągu i opcjonalną wartością ciągu.

take_snapshot

Zapisz migawkę pliku lub folderu wejściowego.

upload_file

Przekaż plik do rekordu uruchomienia.

upload_files

Przekaż pliki do rekordu uruchomienia.

upload_folder

Przekaż określony folder do podanej nazwy prefiksu.

wait_for_completion

Zaczekaj na zakończenie tego uruchomienia. Zwraca obiekt stanu po poczekaniu.

add_properties

Dodaj niezmienne właściwości do przebiegu.

Tagi i właściwości (zarówno DICT [str, str]) różnią się w ich zmienność. Właściwości są niezmienne, więc tworzą stałe rekordy do celów inspekcji. Tagi są modyfikowalne. Aby uzyskać więcej informacji na temat pracy ze znacznikami i właściwościami, zobacz uruchamianie tagów i znajdowanie.

add_properties(properties)

Parametry

properties
dict

Ukryte właściwości przechowywane w obiekcie Run.

add_type_provider

Element Hook rozszerzalności dla niestandardowych typów przebiegów przechowywanych w historii uruchamiania.

add_type_provider(runtype, run_factory)

Parametry

runtype
str

Wartość Run. Type, dla którego zostanie wywołana fabryka. Przykłady obejmują "scriptrun" lub "Azure.", ale można je rozszerzyć przy użyciu typów niestandardowych.

run_factory
<xref:function>

Funkcja z podpisem (eksperymentowanie, RunDto) — > uruchamia się, gdy zostanie wyświetlona lista.

cancel

Oznacz Uruchom jako anulowane.

Jeśli istnieje skojarzone zadanie z określonym polem cancel_uri, Przerwij to zadanie.

cancel()

child_run

Utwórz uruchomienie podrzędne.

child_run(name=None, run_id=None, outputs=None)

Parametry

name
str
wartość domyślna: None

Opcjonalna nazwa dla uruchomienia podrzędnego, zazwyczaj określona dla "części".

run_id
str
wartość domyślna: None

Opcjonalny identyfikator uruchomienia dla elementu podrzędnego, w przeciwnym razie jest generowany automatycznie. Zazwyczaj ten parametr nie jest ustawiony.

outputs
str
wartość domyślna: None

Opcjonalny katalog wyjściowy do śledzenia dla elementu podrzędnego.

Zwraca

Uruchomienie podrzędne.

Typ zwracany

Run

Uwagi

Służy do izolowania części uruchomienia w podsekcji. Można to zrobić w celu zidentyfikowania "części" przebiegu, które są interesujące do oddzielenia, lub przechwytywania niezależnych metryk w ramach procesu podprocesu.

Jeśli katalog wyjściowy jest ustawiony dla uruchomienia podrzędnego, zawartość tego katalogu zostanie przekazana do podrzędnego rekordu uruchomienia po zakończeniu elementu podrzędnego.

clean

Usuń pliki odpowiadające bieżącemu przebiegowi w miejscu docelowym określonym w konfiguracji przebiegu.

clean()

Zwraca

Lista usuniętych plików.

Typ zwracany

complete

Poczekaj na przetworzenie kolejki zadań.

Następnie uruchomienie jest oznaczone jako ukończone. Jest to zwykle używane w scenariuszach interaktywnego notesu.

complete(_set_status=True)

Parametry

_set_status
bool
wartość domyślna: True

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

create_children

Utwórz jeden lub wiele uruchomień podrzędnych.

create_children(count=None, tag_key=None, tag_values=None)

Parametry

count
int
wartość domyślna: None

Opcjonalna liczba elementów podrzędnych do utworzenia.

tag_key
str
wartość domyślna: None

Opcjonalny klucz, aby wypełnić wpis tagów we wszystkich utworzonych elementach podrzędnych.

tag_Values
wartość domyślna: None

Opcjonalna lista wartości, które będą mapowane na Tagi [tag_key] dla listy utworzonych uruchomień.

Zwraca

Lista uruchomień podrzędnych.

Typ zwracany

Uwagi

countNależy określić parametr lub tag_key parametry tag_values .

download_file

Pobierz skojarzony plik z magazynu.

download_file(name, output_file_path=None, _validate_checksum=False)

Parametry

name
str

Nazwa artefaktu do pobrania.

output_file_path
str

Ścieżka lokalna, w której ma zostać zapisany artefakt.

download_files

Pobierz pliki z danego prefiksu (nazwy folderu) lub całego kontenera, jeśli prefiks jest nieokreślony.

download_files(prefix=None, output_directory=None, output_paths=None, batch_size=100, append_prefix=True)

Parametry

prefix
str

Prefiks FilePath w kontenerze, z którego mają zostać pobrane wszystkie artefakty.

output_directory
str

Opcjonalny katalog, którego wszystkie ścieżki artefaktów używają jako prefiksu.

output_paths
[str]

Opcjonalne ścieżki do przechowywania pobranych artefaktów. Powinna być unikatowa i być zgodna z długością ścieżek.

batch_size
int

Liczba plików do pobrania na partię. Wartość domyślna to 100 plików.

append_prefix
bool

Opcjonalna flaga, czy dołączać określony prefiks z ostatniej ścieżki pliku wyjściowego. Jeśli wartość jest równa false, prefiks zostanie usunięty z ścieżki pliku wyjściowego.

fail

Przestarzałe. Użyj <xref:azureml.core.run.tag> , aby oznaczyć przebieg jako zakończony niepowodzeniem lub użyć, cancel Aby oznaczyć Uruchom jako anulowane.

Oznacz przebieg jako zakończony niepowodzeniem.

Opcjonalnie można ustawić właściwość błędu przebiegu z komunikatem lub wyjątek przekazaną do error_details .

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

Parametry

error_details
str lub BaseException
wartość domyślna: None

Opcjonalne szczegóły błędu.

error_code
str
wartość domyślna: None

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

_set_status
bool
wartość domyślna: True

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

flush

Poczekaj na przetworzenie kolejki zadań.

flush(timeout_seconds=300)

Parametry

timeout_seconds
int
wartość domyślna: 300

Czas oczekiwania (w sekundach) na przetworzenie kolejki zadań.

get

Pobierz przebieg dla tego obszaru roboczego z IDENTYFIKATORem jego przebiegu.

get(workspace, run_id)

Parametry

workspace
Workspace

Zawierający obszar roboczy.

run_id
string

Identyfikator uruchomienia.

Zwraca

Przesłany przebieg.

Typ zwracany

Run

get_all_logs

Pobierz wszystkie dzienniki dla uruchomienia do katalogu.

get_all_logs(destination=None)

Parametry

destination
str
wartość domyślna: None

Ścieżka docelowa do przechowywania dzienników. Jeśli nie zostanie określony, katalog o nazwie ID przebiegu zostanie utworzony w katalogu projektu.

Zwraca

Lista nazw pobranych dzienników.

Typ zwracany

get_children

Pobierz wszystkie elementy podrzędne dla bieżącego przebiegu wybranego przez określone filtry.

get_children(recursive=False, tags=None, properties=None, type=None, status=None, _rehydrate_runs=True)

Parametry

recursive
bool
wartość domyślna: False

Wskazuje, czy należy powtórzyć wszystkie elementy podrzędne.

tags
str lub dict
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca przebiegi pasujące do określonego "tag" lub "tag": "value"}.

properties
str lub dict
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca uruchomienia zgodne z określoną właściwością "Property" lub {"Property": "value"}.

type
str
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca uruchomienia zgodne z tym typem.

status
str
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca przebiegi z określonym stanem "status".

_rehydrate_runs
bool
wartość domyślna: True

Wskazuje, czy chcesz utworzyć wystąpienie uruchomienia oryginalnego typu, czy podstawowego uruchomienia.

Zwraca

Lista Run obiektów.

Typ zwracany

get_context

Zwróć bieżący kontekst usługi.

Użyj tej metody, aby pobrać bieżący kontekst usługi na potrzeby rejestrowania metryk i przekazywania plików. Jeśli allow_offline wartość jest równa true (domyślnie), akcje względem obiektu Run zostaną wydrukowane do warstwy Standardowa.

get_context(allow_offline=True, used_for_context_manager=False, **kwargs)

Parametry

cls

Wskazuje metodę klasy.

allow_offline
bool
wartość domyślna: True

Zezwól na powrót kontekstu usługi do trybu offline, aby skrypt szkoleniowy mógł zostać przetestowany lokalnie bez przesyłania zadania w zestawie SDK. Domyślnie wartość true.

kwargs
dict
wartość domyślna: False

Słownik dodatkowych parametrów.

Zwraca

Przesłany przebieg.

Typ zwracany

Run

Uwagi

Ta funkcja jest często używana do pobierania uwierzytelnionego obiektu Run wewnątrz skryptu, który ma zostać przesłany do wykonania za pośrednictwem eksperymentu. Submit (). Ten obiekt Run to uwierzytelniony kontekst do komunikowania się z usługami Azure Machine Learning i kontenera koncepcyjnego, w którym znajdują się metryki, pliki (artefakty) i modele.


   run = Run.get_context() # allow_offline=True by default, so can be run locally as well
   ...
   run.log("Accuracy", 0.98)
   run.log_row("Performance", epoch=e, error=err)

get_detailed_status

Pobierz najnowszy stan przebiegu. Jeśli stan uruchomienia to "w kolejce", zostaną wyświetlone szczegóły.

get_detailed_status()

Zwraca

Najnowszy stan i szczegóły

Typ zwracany

Uwagi

  • stan: bieżący stan przebiegu. Taka sama wartość jak zwracana z get_Status ().

  • szczegóły: szczegółowe informacje dotyczące bieżącego stanu.


   run = experiment.submit(config)
   details = run.get_detailed_status()
   # details = {
   #     'status': 'Queued',
   #     'details': 'Run requested 1 node(s). Run is in pending status.',
   # }

get_details

Pobierz definicję, informacje o stanie, bieżące pliki dziennika i inne szczegóły przebiegu.

get_details()

Zwraca

Zwróć szczegóły przebiegu

Typ zwracany

Uwagi

Zwrócony słownik zawiera następujące pary klucz-wartość:

  • runId: Identyfikator tego przebiegu.

  • obiektów

  • stan: bieżący stan przebiegu. Taka sama wartość jak zwracana z get_Status ().

  • startTimeUtc: czas UTC uruchomienia tego przebiegu w ISO8601.

  • endTimeUtc: czas UTC zakończenia tego przebiegu (ukończono lub Zakończono niepowodzeniem) w ISO8601.

    Ten klucz nie istnieje, jeśli przebieg jest nadal w toku.

  • Właściwości: niezmienna para klucz-wartość skojarzona z przebiegiem. Właściwości domyślne obejmują identyfikator migawki przebiegu i informacje o repozytorium git, z którego utworzono ten przebieg (jeśli istnieje). Dodatkowe właściwości można dodać do uruchomienia przy użyciu add_properties .

  • inputDatasets: wejściowe zestawy danych skojarzone z przebiegiem.

  • outputDatasets: wyjściowe zestawy danych skojarzone z przebiegiem.

  • logFiles

  • submittedBy


   run = experiment.start_logging()

   details = run.get_details()
   # details = {
   #     'runId': '5c24aa28-6e4a-4572-96a0-fb522d26fe2d',
   #     'target': 'sdk',
   #     'status': 'Running',
   #     'startTimeUtc': '2019-01-01T13:08:01.713777Z',
   #     'endTimeUtc': '2019-01-01T17:15:65.986253Z',
   #     'properties': {
   #         'azureml.git.repository_uri': 'https://example.com/my/git/repo',
   #         'azureml.git.branch': 'master',
   #         'azureml.git.commit': '7dc972657c2168927a02c3bc2b161e0f370365d7',
   #         'azureml.git.dirty': 'True',
   #         'mlflow.source.git.repoURL': 'https://example.com/my/git/repo',
   #         'mlflow.source.git.branch': 'master',
   #         'mlflow.source.git.commit': '7dc972657c2168927a02c3bc2b161e0f370365d7',
   #         'ContentSnapshotId': 'b4689489-ce2f-4db5-b6d7-6ad11e77079c'
   #     },
   #     'inputDatasets': [{
   #         'dataset': {'id': 'cdebf245-701d-4a68-8055-41f9cf44f298'},
   #         'consumptionDetails': {
   #             'type': 'RunInput',
   #             'inputName': 'training-data',
   #             'mechanism': 'Mount',
   #             'pathOnCompute': '/mnt/datasets/train'
   #         }
   #     }],
   #     'outputDatasets': [{
   #         'dataset': {'id': 'd04e8a19-1caa-4b1f-b318-4cbff9af9615'},
   #         'outputType': 'RunOutput',
   #         'outputDetails': {
   #             'outputName': 'training-result'
   #         }
   #     }],
   #     'runDefinition': {},
   #     'logFiles': {},
   #     'submittedBy': 'Alan Turing'
   # }

get_details_with_logs

Zwróć stan uruchomienia wraz z zawartością pliku dziennika.

get_details_with_logs()

Zwraca

Zwraca stan uruchomienia z zawartością pliku dziennika.

Typ zwracany

get_environment

Pobierz definicję środowiska, która była używana w tym przebiegu.

get_environment()

Zwraca

Zwróć obiekt środowiska.

Typ zwracany

get_file_names

Wyświetl listę plików, które są przechowywane w skojarzeniu z przebiegiem.

get_file_names()

Zwraca

Lista ścieżek dla istniejących artefaktów

Typ zwracany

get_metrics

Pobierz metryki zarejestrowane do uruchomienia.

Jeśli recursive ma wartość true (domyślnie false), a następnie pobierze metryki dla przebiegów w poddrzewie danego uruchomienia.

get_metrics(name=None, recursive=False, run_type=None, populate=False)

Parametry

name
str
wartość domyślna: None

Nazwa metryki.

recursive
bool
wartość domyślna: False

Wskazuje, czy należy powtórzyć wszystkie elementy podrzędne.

run_type
str
wartość domyślna: None
populate
bool
wartość domyślna: False

Wskazuje, czy ma zostać pobrana zawartość zewnętrznych danych połączonych z metryką.

Zwraca

Słownik zawierający metryki użytkowników.

Typ zwracany

Uwagi


   run = experiment.start_logging() # run id: 123
   run.log("A", 1)
   with run.child_run() as child: # run id: 456
       child.log("A", 2)

   metrics = run.get_metrics()
   # metrics = { 'A': 1 }

   metrics = run.get_metrics(recursive=True)
   # metrics = { '123': { 'A': 1 }, '456': { 'A': 2 } } note key is runId

get_properties

Pobierz najnowsze właściwości przebiegu z usługi.

get_properties()

Zwraca

Właściwości przebiegu.

Typ zwracany

Uwagi

Właściwości to niezmienne informacje generowane przez system, takie jak czas trwania, Data wykonania, użytkownik i niestandardowe właściwości dodane przy użyciu add_properties metody. Aby uzyskać więcej informacji, zobacz Tagi i Znajdź uruchomienia.

Podczas przesyłania zadania do Azure Machine Learning, jeśli pliki źródłowe są przechowywane w lokalnym repozytorium git, informacje o repozytorium są przechowywane jako właściwości. Te właściwości git są dodawane podczas tworzenia lub wywoływania eksperymentu. Prześlij. Aby uzyskać więcej informacji na temat właściwości git, zobacz Integracja z usługą git dla Azure Machine Learning.

get_secret

Pobierz wartość klucza tajnego z kontekstu uruchomienia.

Pobierz wartość wpisu tajnego dla podanej nazwy. Nazwa wpisu tajnego odwołuje się do wartości przechowywanej w Azure Key Vault skojarzonej z obszarem roboczym. Przykład pracy z wpisami tajnymi można znaleźć w temacie Korzystanie z wpisów tajnych w programie szkoleniowym.

get_secret(name)

Parametry

name
str

Nazwa wpisu tajnego, dla którego ma zostać zwrócony klucz tajny.

Zwraca

Wartość klucza tajnego.

Typ zwracany

str

get_secrets

Pobierz wartości tajne dla danej listy nazw wpisów tajnych.

Pobierz słownik znalezionych i nieznalezionych wpisów tajnych dla listy podanych nazw. Każda nazwa klucza tajnego odwołuje się do wartości przechowywanej w Azure Key Vault skojarzonej z obszarem roboczym. Przykład pracy z wpisami tajnymi można znaleźć w temacie Korzystanie z wpisów tajnych w programie szkoleniowym.

get_secrets(secrets)

Parametry

secrets
list[str]

Lista nazw wpisów tajnych, dla których mają zostać zwrócone wartości tajne.

Zwraca

Zwraca słownik znalezionych i nieznalezionych wpisów tajnych.

Typ zwracany

dict[<xref:str: str>]

get_snapshot_id

Pobierz najnowszy identyfikator migawki.

get_snapshot_id()

Zwraca

Ostatni identyfikator migawki.

Typ zwracany

str

get_status

Pobierz najnowszy stan przebiegu.

Zwrócone wartości są następujące: "uruchomiona", "ukończone" i "Niepowodzenie".

get_status()

Zwraca

Najnowszy stan.

Typ zwracany

str

Uwagi

  • NotStarted — jest to tymczasowe obiekty uruchomieniowe po stronie klienta, które znajdują się przed przesłaniem do chmury.

  • Uruchamianie — rozpoczęto przetwarzanie przebiegu w chmurze. W tym momencie obiekt wywołujący ma identyfikator uruchomienia.

  • Inicjowanie obsługi — zwracanego podczas tworzenia obliczeń na żądanie dla danego przesłania zadania.

  • Przygotowywanie — środowisko uruchomieniowe jest przygotowywane:

    • Kompilacja obrazu platformy Docker

    • Konfiguracja środowiska Conda

  • W kolejce — zadanie jest umieszczane w kolejce w elemencie docelowym obliczeń. Na przykład w Batchai Job stan zadania jest w kolejce.

    podczas oczekiwania na gotowość wszystkich żądanych węzłów.

  • Uruchomiona — zadanie zostało uruchomione w celu wykonania w elemencie docelowym obliczeń.

  • Finalizowanie — kod użytkownika został ukończony, a przebieg znajduje się w etapach przetwarzania końcowego.

  • CancelRequested — dla zadania zażądano anulowania.

  • Ukończono — przebieg został ukończony pomyślnie. Obejmuje to zarówno kod użytkownika, jak i przebieg

    etapy przetwarzania końcowego.

  • Niepowodzenie — uruchomienie nie powiodło się. Zazwyczaj Właściwość błędu w przebiegu zawiera szczegółowe informacje dotyczące przyczyn.

  • Anulowano — następuje anulowanie żądania anulowania i wskazuje, że uruchomienie zostało pomyślnie anulowane.

  • NotResponding — w przypadku przebiegów z włączonymi pulsami nie został niedawno wysłany żaden puls.


   run = experiment.submit(config)
   while run.get_status() not in ['Completed', 'Failed']: # For example purposes only, not exhaustive
       print('Run {} not in terminal state'.format(run.id))
       time.sleep(10)

get_submitted_run

Przestarzałe. Użyj polecenia get_context.

Pobierz przesłany przebieg dla tego eksperymentu.

get_submitted_run(**kwargs)

Parametry

cls

Zwraca

Przesłany przebieg.

Typ zwracany

Run

get_tags

Pobierz najnowszy zestaw modyfikowalnych tagów w przebiegu z usługi.

get_tags()

Zwraca

Tagi przechowywane w obiekcie Run.

Typ zwracany

list

Pobierz listę przebiegów w ramach eksperymentu określonego przez filtry opcjonalne.

list(experiment, type=None, tags=None, properties=None, status=None, include_children=False, _rehydrate_runs=True)

Parametry

experiment
Experiment

Zawierający eksperyment.

type
str
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca uruchomienia zgodne z określonym typem.

tags
str lub dict
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca przebiegi pasujące do określonego "tag" lub "tag": "value"}.

properties
str lub dict
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca uruchomienia zgodne z określoną właściwością "Property" lub {"Property": "value"}.

status
str
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca przebiegi z określonym stanem "status".

include_children
bool
wartość domyślna: False

W przypadku ustawienia wartości true należy pobrać wszystkie uruchomienia, a nie tylko na najwyższego poziomu.

_rehydrate_runs
bool
wartość domyślna: True

Jeśli wartość jest ustawiona na true (domyślnie), program będzie używać zarejestrowanego dostawcy do zmiany wystąpienia obiektu dla tego typu zamiast podstawowego uruchomienia.

Zwraca

Lista uruchomień.

Typ zwracany

Uwagi

Poniższy przykład kodu pokazuje niektóre zastosowania list metody.


   favorite_completed_runs = Run.list(experiment, status='Completed', tags='favorite')

   all_distinct_runs = Run.list(experiment)
   and_their_children = Run.list(experiment, include_children=True)

   only_script_runs = Run.list(experiment, type=ScriptRun.RUN_TYPE)

list_by_compute

Pobierz listę przebiegów w ramach obliczeń określonych przez opcjonalne filtry.

list_by_compute(compute, type=None, tags=None, properties=None, status=None)

Parametry

compute
ComputeTarget

Zawierające obliczenia.

type
str
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca uruchomienia zgodne z określonym typem.

tags
str lub dict
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca przebiegi pasujące do określonego "tag" lub "tag": "value"}.

properties
str lub dict
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca uruchomienia zgodne z określoną właściwością "Property" lub {"Property": "value"}.

status
str
wartość domyślna: None

Jeśli ta wartość jest określona, zwraca przebiegi z określonym stanem "status". Dozwolone są tylko wartości "running" i "queued".

Zwraca

Generator ~ _restclient. models. RunDto

Typ zwracany

<xref:builtin.generator>

log

Rejestruj wartość metryki do uruchomienia o podaną nazwę.

log(name, value, description='')

Parametry

name
str

Nazwa metryki.

value

Wartość do opublikowania w usłudze.

description
str

Opcjonalny opis metryki.

Uwagi

Zarejestrowanie metryki w przebiegu powoduje, że Metryka jest przechowywana w rekordzie uruchomienia w eksperymentie. Tę samą metrykę można rejestrować wiele razy w ramach przebiegu, dlatego wynik jest uznawany za wektor tej metryki.

log_accuracy_table

Rejestruj tabelę dokładności do magazynu artefaktów.

Metryka tabeli dokładności jest metryką wielokrotnego użytku, która nie jest skalarna, która może służyć do tworzenia wielu typów wykresów liniowych, które zmieniają się w sposób ciągły w miejscu przewidywanych prawdopodobieństw. Przykłady tych wykresów to ROC, Precision-Call i unieś krzywe.

Obliczenie tabeli dokładności jest podobne do obliczenia krzywej ROC. Krzywa ROC przechowuje prawdziwe dodatnie stawki i fałszywie dodatnie stawki dla wielu różnych progów prawdopodobieństwa. W tabeli dokładności przechowywane są nieprzetworzone liczby dodatnie pozytywne, fałszywe dodatnie, prawdziwe ujemne i fałszywe wartości ujemne z wieloma progami prawdopodobieństwa.

Istnieją dwie metody używane do wybierania progów: "prawdopodobieństwo" i "percentyl". Różnią się one sposobem próbkowania od miejsca przewidywanych prawdopodobieństw.

Progi prawdopodobieństwa są równomiernie rozmieszczone progi z zakresu od 0 do 1. Jeśli NUM_POINTS wynosi 5 progi prawdopodobieństwa byłyby [0,0, 0,25, 0,5, 0,75, 1,0].

Progi percentylu są rozjmowane w zależności od rozkładu przewidywanych prawdopodobieństw. Każdy próg odnosi się do percentylu danych przy progu prawdopodobieństwa. Na przykład jeśli NUM_POINTS ma wartość 5, pierwszy próg będzie 0th percentyl, drugi o 25 percentyl, trzeci w pięćdziesiąt i tak dalej.

Tabele prawdopodobieństwa i tabele percentylu są listami 3W, w których pierwszy wymiar reprezentuje etykietę klasy, drugi wymiar reprezentuje próbkę z jednym progiem (skaluje się NUM_POINTS), a trzeci wymiar zawsze ma 4 wartości: TP, FP, TN, FN i zawsze w tej kolejności.

Wartości niepomylene (TP, FP, TN, FN) są obliczane przy użyciu jednej strategii a. Rest. Aby uzyskać więcej informacji, zobacz następujący link: https://en.wikipedia.org/wiki/Multiclass_classification

N = liczba próbek w zestawie danych walidacji (200 w przykładzie) M = # Threshold = # próbek pobranych z przestrzeni prawdopodobieństwa (5 na przykład) C = # klas w pełnym zestawie danych (3 na przykład)

Niektóre niewarianty tabeli dokładności:

  • TP + FP + TN + FN = N dla wszystkich progów dla wszystkich klas
  • TP + FN jest taka sama dla wszystkich progów dla każdej klasy
  • TN + FP jest taka sama dla wszystkich progów dla każdej klasy
  • Tabele prawdopodobieństwa i tabele percentylu mają kształt [C, M, 4]

Uwaga: M może być dowolną wartością i kontroluje rozdzielczość wykresów, ponieważ jest ona niezależna od zestawu danych, jest definiowana podczas obliczania metryk i handlu poza miejscem do magazynowania, czasem obliczeniowym i rozdzielczością.

Etykiety klas powinny być ciągami, dlatego wartości niepomylene powinny być liczbami całkowitymi, a wartości progowe powinny być zmiennoprzecinkowe.

log_accuracy_table(name, value, description='')

Parametry

name
str

Nazwa tabeli dokładności.

value
str lub dict

Plik JSON zawierający nazwę, wersję i właściwości danych.

description
str

Opcjonalny opis metryki.

Uwagi

Przykład prawidłowej wartości JSON:


   {
       "schema_type": "accuracy_table",
       "schema_version": "1.0.1",
       "data": {
           "probability_tables": [
               [
                   [82, 118, 0, 0],
                   [75, 31, 87, 7],
                   [66, 9, 109, 16],
                   [46, 2, 116, 36],
                   [0, 0, 118, 82]
               ],
               [
                   [60, 140, 0, 0],
                   [56, 20, 120, 4],
                   [47, 4, 136, 13],
                   [28, 0, 140, 32],
                   [0, 0, 140, 60]
               ],
               [
                   [58, 142, 0, 0],
                   [53, 29, 113, 5],
                   [40, 10, 132, 18],
                   [24, 1, 141, 34],
                   [0, 0, 142, 58]
               ]
           ],
           "percentile_tables": [
               [
                   [82, 118, 0, 0],
                   [82, 67, 51, 0],
                   [75, 26, 92, 7],
                   [48, 3, 115, 34],
                   [3, 0, 118, 79]
               ],
               [
                   [60, 140, 0, 0],
                   [60, 89, 51, 0],
                   [60, 41, 99, 0],
                   [46, 5, 135, 14],
                   [3, 0, 140, 57]
               ],
               [
                   [58, 142, 0, 0],
                   [56, 93, 49, 2],
                   [54, 47, 95, 4],
                   [41, 10, 132, 17],
                   [3, 0, 142, 55]
               ]
           ],
           "probability_thresholds": [0.0, 0.25, 0.5, 0.75, 1.0],
           "percentile_thresholds": [0.0, 0.01, 0.24, 0.98, 1.0],
           "class_labels": ["0", "1", "2"]
       }
   }

log_confusion_matrix

Rejestruj niepomyleną macierz do magazynu artefaktów.

Spowoduje to zarejestrowanie otoki wokół skryptu sklearn niemylenej macierzy. Dane metryki zawierają etykiety klas i listę 2D dla samej macierzy. Aby uzyskać więcej informacji na temat obliczania metryki, zobacz następujący link: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html

log_confusion_matrix(name, value, description='')

Parametry

name
str

Nazwa matrycy niemylącej.

value
str lub dict

Plik JSON zawierający nazwę, wersję i właściwości danych.

description
str

Opcjonalny opis metryki.

Uwagi

Przykład prawidłowej wartości JSON:


   {
       "schema_type": "confusion_matrix",
       "schema_version": "1.0.0",
       "data": {
           "class_labels": ["0", "1", "2", "3"],
           "matrix": [
               [3, 0, 1, 0],
               [0, 1, 0, 1],
               [0, 0, 1, 0],
               [0, 0, 0, 1]
           ]
       }
   }

log_image

Rejestruj metrykę obrazu do rekordu uruchomienia.

log_image(name, path=None, plot=None, description='')

Parametry

name
str

Nazwa metryki.

path
str

Ścieżka lub strumień obrazu.

plot
<xref:matplotlib.pyplot>

Wykres, który ma być zalogowany jako obraz.

description
str

Opcjonalny opis metryki.

Uwagi

Ta metoda służy do rejestrowania pliku obrazu lub wykresu matplotlib do uruchomienia. Te obrazy będą widoczne i porównywalne w rekordzie uruchomienia.

log_list

Rejestruj listę wartości metryk do uruchomienia o podanej nazwie.

log_list(name, value, description='')

Parametry

name
str

Nazwa metryki.

value
list

Wartości metryki.

description
str

Opcjonalny opis metryki.

log_predictions

Rejestruj przewidywania do magazynu artefaktów.

To rejestruje ocenę metryki, która może służyć do porównywania rozkładów prawdziwych wartości docelowych do dystrybucji prognozowanych wartości dla zadania regresji.

Przewidywania to Binned, a standardowe odchylenia są obliczane dla słupków błędów na wykresie liniowym.

log_predictions(name, value, description='')

Parametry

name
str

Nazwa prognoz.

value
str lub dict

Plik JSON zawierający nazwę, wersję i właściwości danych.

description
str

Opcjonalny opis metryki.

Uwagi

Przykład prawidłowej wartości JSON:


   {
       "schema_type": "predictions",
       "schema_version": "1.0.0",
       "data": {
           "bin_averages": [0.25, 0.75],
           "bin_errors": [0.013, 0.042],
           "bin_counts": [56, 34],
           "bin_edges": [0.0, 0.5, 1.0]
       }
   }

log_residuals

Rejestruje reszty w magazynie artefaktów.

To rejestruje dane, które są konieczne do wyświetlenia histogramu reszty dla zadania regresji. Reszty są przewidywane w rzeczywistości.

Powinna istnieć jeszcze jedna krawędź niż liczba. Zapoznaj się z dokumentacją histogramu numpy, aby poznać przykłady użycia liczników i krawędzi do reprezentowania histogramu. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html

log_residuals(name, value, description='')

Parametry

name
str

Nazwa pozostałych elementów.

value
str lub dict

Plik JSON zawierający nazwę, wersję i właściwości danych.

description
str

Opcjonalny opis metryki.

Uwagi

Przykład prawidłowej wartości JSON:


   {
       "schema_type": "residuals",
       "schema_version": "1.0.0",
       "data": {
           "bin_edges": [50, 100, 200, 300, 350],
           "bin_counts": [0.88, 20, 30, 50.99]
       }
   }

log_row

Rejestruj metrykę wiersza do uruchomienia o podaną nazwę.

log_row(name, description=None, **kwargs)

Parametry

name
str

Nazwa metryki.

description
str
wartość domyślna: None

Opcjonalny opis metryki.

kwargs
dict

Słownik dodatkowych parametrów. W tym przypadku kolumny metryki.

Uwagi

Za pomocą log_row tworzy metrykę tabeli z kolumnami, zgodnie z opisem w kwargs. Każdy nazwany parametr generuje kolumnę o określonej wartości. log_row może być wywoływana raz, aby zarejestrować dowolną spójność lub wiele razy w pętli w celu wygenerowania kompletnej tabeli.


   citrus = ['orange', 'lemon', 'lime']
   sizes = [ 10, 7, 3]
   for index in range(len(citrus)):
       run.log_row("citrus", fruit = citrus[index], size=sizes[index])

log_table

Rejestruj metrykę tabeli do uruchomienia o podaną nazwę.

log_table(name, value, description='')

Parametry

name
str

Nazwa metryki.

value
dict

Wartość tabeli metryki, słownik, w którym klucze są kolumnami do opublikowania w usłudze.

description
str

Opcjonalny opis metryki.

register_model

Zarejestruj model dla operacjonalizacji.

register_model(model_name, model_path=None, tags=None, properties=None, model_framework=None, model_framework_version=None, description=None, datasets=None, sample_input_dataset=None, sample_output_dataset=None, resource_configuration=None, **kwargs)

Parametry

model_name
str

Nazwa modelu.

model_path
str
wartość domyślna: None

Względna ścieżka w chmurze do modelu, na przykład "Output/ModelName". Jeśli ścieżka nie zostanie określona (brak), model_name jest używana.

tags
dict[str, str]
wartość domyślna: None

Słownik tagów wartości klucza do przypisania do modelu.

properties
dict[str, str]
wartość domyślna: None

Słownik właściwości wartości klucza do przypisania do modelu. Tych właściwości nie można zmienić po utworzeniu modelu, ale można dodać nowe pary klucz wartość.

model_framework
str
wartość domyślna: None

Struktura modelu do zarejestrowania. Obecnie obsługiwane struktury: TensorFlow, ScikitLearn, Onnx, Custom, wiele

model_framework_version
str
wartość domyślna: None

Wersja struktury zarejestrowanego modelu.

description
str
wartość domyślna: None

Opcjonalny opis modelu.

datasets
list[(str, AbstractDataset)]
wartość domyślna: None

Lista krotek, w których pierwszy element opisuje relację między modelem zestawu danych, a drugi element jest zestawem danych.

sample_input_dataset
AbstractDataset
wartość domyślna: None

Opcjonalny. Przykładowy zestaw danych wejściowych dla zarejestrowanego modelu

sample_output_dataset
AbstractDataset
wartość domyślna: None

Opcjonalny. Przykładowy wyjściowy zestaw danych dla zarejestrowanego modelu

resource_configuration
ResourceConfiguration
wartość domyślna: None

Opcjonalny. Konfiguracja zasobu do uruchomienia zarejestrowanego modelu

kwargs
dict

Parametry opcjonalne.

Zwraca

Zarejestrowany model.

Typ zwracany

Uwagi


   model = best_run.register_model(model_name = 'best_model', model_path = 'outputs/model.pkl')

remove_tags

Usuń listę modyfikowalnych tagów w tym przebiegu.

remove_tags(tags)

Parametry

tags
list

Lista tagów do usunięcia.

Zwraca

Tagi przechowywane w obiekcie Run

restore_snapshot

Przywróć migawkę jako plik ZIP. Zwraca ścieżkę do pliku ZIP.

restore_snapshot(snapshot_id=None, path=None)

Parametry

snapshot_id
str
wartość domyślna: None

Identyfikator migawki do przywrócenia. Najnowsza jest używana, jeśli nie zostanie określony.

path
str
wartość domyślna: None

Ścieżka, w której zapisano pobrany plik ZIP.

Zwraca

Ścieżka.

Typ zwracany

str

set_tags

Dodawanie lub modyfikowanie zestawu tagów w przebiegu. Tagi, które nie są przenoszone w słowniku, są pozostawione w niezmienionej postaci.

Możesz również dodać proste Tagi ciągu. Gdy Tagi są wyświetlane w słowniku tagów jako klucze, mają wartość none. Aby uzyskać więcej informacji, zobacz Tagi i Znajdź uruchomienia.

set_tags(tags)

Parametry

tags
dict[str] lub str

Tagi przechowywane w obiekcie Run.

start

Oznacz przebieg jako uruchomiony.

Jest to zwykle używane w zaawansowanych scenariuszach, gdy przebieg został utworzony przez innego aktora.

start()

submit_child

Przesyłanie eksperymentu i powrót do aktywnego przebiegu podrzędnego.

submit_child(config, tags=None, **kwargs)

Parametry

config
object

Konfiguracja do przesłania.

tags
dict
wartość domyślna: None

Tagi do dodania do przesłanego przebiegu, np., {"tag": "value"}.

kwargs
dict

Dodatkowe parametry używane w funkcji przesyłania dla konfiguracji.

Zwraca

Obiekt run.

Typ zwracany

Run

Uwagi

Przesyłanie jest wywołaniem asynchronicznym do platformy Azure Machine Learning w celu wykonania wersji próbnej na sprzęcie lokalnym lub zdalnym. W zależności od konfiguracji przesyłanie automatycznie przygotuje środowiska wykonawcze, wykona kod i przechwytuje kod źródłowy oraz wyniki do historii przebiegów eksperymentu.

Aby przesłać eksperyment, musisz najpierw utworzyć obiekt konfiguracji opisujący sposób działania eksperymentu. Konfiguracja zależy od typu wymaganej wersji próbnej.

Przykład przesyłania eksperymentu podrzędnego z komputera lokalnego przy użyciu programu ScriptRunConfig jest następujący:


   from azureml.core import ScriptRunConfig

   # run a trial from the train.py code in your current directory
   config = ScriptRunConfig(source_directory='.', script='train.py',
       run_config=RunConfiguration())
   run = parent_run.submit_child(config)

   # get the url to view the progress of the experiment and then wait
   # until the trial is complete
   print(run.get_portal_url())
   run.wait_for_completion()

Aby uzyskać szczegółowe informacje na temat konfigurowania przebiegu, zobacz submit .

tag

Oznacz przebieg z kluczem ciągu i opcjonalną wartością ciągu.

tag(key, value=None)

Parametry

key
str

Klucz tagu

value
str
wartość domyślna: None

Opcjonalna wartość dla tagu

Uwagi

Tagi i właściwości w przebiegu są słownikami ciągu > String. Różnica między nimi jest zmienność: Tagi mogą być ustawiane, aktualizowane i usuwane, gdy właściwości mogą być dodawane tylko. Sprawia to, że właściwości są bardziej odpowiednie dla wyzwalaczy zachowania związanego z systemem/przepływem pracy, natomiast Tagi są ogólnie dostępne dla użytkowników i mają znaczenie dla konsumentów eksperymentu.


   run = experiment.start_logging()
   run.tag('DeploymentCandidate')
   run.tag('modifiedBy', 'Master CI')
   run.tag('modifiedBy', 'release pipeline') # Careful, tags are mutable

   run.add_properties({'BuildId': os.environ.get('VSTS_BUILD_ID')}) # Properties are not

   tags = run.get_tags()
   # tags = { 'DeploymentCandidate': None, 'modifiedBy': 'release pipeline' }

take_snapshot

Zapisz migawkę pliku lub folderu wejściowego.

take_snapshot(file_or_folder_path)

Parametry

file_or_folder_path
str

Plik lub folder zawierający kod źródłowy uruchomienia.

Zwraca

Zwraca identyfikator migawki.

Typ zwracany

str

Uwagi

Migawki mają być kodem źródłowym używanym do wykonywania eksperymentu. Są one przechowywane w przebiegu, aby umożliwić replikację w przyszłości.

Uwaga

Migawki są automatycznie podejmowane po submit wywołaniu. Zazwyczaj ta metoda take_snapshot jest wymagana tylko w przypadku uruchamiania interakcyjnego (notesu).

upload_file

Przekaż plik do rekordu uruchomienia.

upload_file(name, path_or_stream)

Parametry

name
str

Nazwa pliku do przekazania.

path_or_stream
str

Względna ścieżka lokalna lub strumień do pliku do przekazania.

Typ zwracany

Uwagi


   run = experiment.start_logging()
   run.upload_file(name='important_file', path_or_stream="path/on/disk/file.txt")

Uwaga

Uruchamia Automatyczne przechwytywanie pliku w określonym katalogu wyjściowym, który domyślnie przyjmuje wartość "./Outputs" dla większości typów uruchomienia. Użyj upload_file tylko wtedy, gdy trzeba przekazać dodatkowe pliki lub nie określono katalogu wyjściowego.

upload_files

Przekaż pliki do rekordu uruchomienia.

upload_files(names, paths, return_artifacts=False, timeout_seconds=None)

Parametry

names
list

Nazwy plików do przekazania. Jeśli jest ustawiona, należy również ustawić ścieżki.

paths
list

Względne ścieżki lokalne do plików do przekazania. Jeśli jest ustawiona, wymagane są nazwy.

return_artifacts
bool

Wskazuje, że należy zwrócić obiekt artefaktu dla każdego przekazanego pliku.

timeout_seconds
int

Limit czasu przekazywania plików.

Uwagi

upload_files ma ten sam efekt jak upload_file w przypadku oddzielnych plików, jednak w przypadku korzystania z programu są dostępne zalety wydajności i wykorzystania zasobów upload_files .


   import os

   run = experiment.start_logging()
   file_name_1 = 'important_file_1'
   file_name_2 = 'important_file_2'
   run.upload_files(names=[file_name_1, file_name_2],
                       paths=['path/on/disk/file_1.txt', 'other/path/on/disk/file_2.txt'])

   run.download_file(file_name_1, 'file_1.txt')

   os.mkdir("path")  # The path must exist
   run.download_file(file_name_2, 'path/file_2.txt')

Uwaga

Uruchamia automatyczne Przechwytywanie plików w określonym katalogu wyjściowym, który domyślnie jest "./Outputs" dla większości typów uruchomienia. Użyj upload_files tylko wtedy, gdy trzeba przekazać dodatkowe pliki lub nie określono katalogu wyjściowego.

upload_folder

Przekaż określony folder do podanej nazwy prefiksu.

upload_folder(name, path)

Parametry

name
str

Nazwa folderu plików do przekazania.

folder
str

Względna ścieżka lokalna do folderu do przekazania.

Uwagi


   run = experiment.start_logging()
   run.upload_folder(name='important_files', path='path/on/disk')

   run.download_file('important_files/existing_file.txt', 'local_file.txt')

Uwaga

Uruchamia automatyczne Przechwytywanie plików w określonym katalogu wyjściowym, który domyślnie jest "./Outputs" dla większości typów uruchomienia. Użyj upload_folder tylko wtedy, gdy trzeba przekazać dodatkowe pliki lub nie określono katalogu wyjściowego.

wait_for_completion

Zaczekaj na zakończenie tego uruchomienia. Zwraca obiekt stanu po poczekaniu.

wait_for_completion(show_output=False, wait_post_processing=False, raise_on_error=True)

Parametry

show_output
bool
wartość domyślna: False

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

wait_post_processing
bool
wartość domyślna: False

Wskazuje, czy poczekać na zakończenie przetwarzania końcowego po zakończeniu wykonywania.

raise_on_error
bool
wartość domyślna: True

Wskazuje, czy błąd jest wywoływany, gdy przebieg jest w stanie niepowodzenia.

Zwraca

Obiekt stanu.

Typ zwracany

Atrybuty

experiment

Pobierz eksperyment zawierający przebieg.

Zwraca

Pobiera eksperyment odpowiadający przebiegowi.

Typ zwracany

id

Pobierz identyfikator przebiegu.

Identyfikator przebiegu jest unikatowym identyfikatorem w ramach zawierającego eksperymentu.

Zwraca

Identyfikator uruchomienia.

Typ zwracany

str

name

Zwróć nazwę uruchomienia.

Opcjonalna nazwa przebiegu to ciąg określony przez użytkownika, przydatny do późniejszej identyfikacji przebiegu.

Zwraca

Identyfikator uruchomienia.

Typ zwracany

str

number

Pobierz numer uruchomienia.

Monotonicznie zwiększający porządek przebiegów w ramach eksperymentu.

Zwraca

Numer uruchomienia.

Typ zwracany

int

parent

Pobierz uruchomienie elementu nadrzędnego dla tego przebiegu z usługi.

Przebiegi mogą mieć opcjonalny element nadrzędny, co spowodowało potencjalną hierarchię drzewa przebiegów. Aby rejestrować metryki do uruchomienia nadrzędnego, użyj log metody obiektu nadrzędnego, na przykład run.parent.log() .

Zwraca

Element nadrzędny lub brak, jeśli nie jest ustawiony.

Typ zwracany

Run

properties

Zwróć niezmienne właściwości tego przebiegu.

Zwraca

Buforowane lokalnie właściwości przebiegu.

Typ zwracany

dict[str],
str

Uwagi

Właściwości obejmują niezmienne informacje generowane przez system, takie jak czas trwania, Data wykonania, użytkownik itp.

status

Zwróć stan obiektu Run.

tags

Zwróć zestaw modyfikowalnych tagów w tym przebiegu.

Zwraca

Tagi przechowywane w obiekcie Run.

Typ zwracany

type

Pobierz typ uruchomienia.

Wskazuje, w jaki sposób przebieg został utworzony lub skonfigurowany.

Zwraca

Typ uruchomienia.

Typ zwracany

str