Run Třída

Definuje základní třídu pro všechny spuštění experimentu Azure Machine Learning.

Spuštění představuje jednu zkušební verzi experimentu. Spuštění se používají k monitorování asynchronního spouštění zkušební verze, metrik protokolů a ukládání výstupu zkušební verze a k analýze výsledků a přístupových artefaktů vygenerovaných zkušební verzí.

Spuštění objektů se vytvoří při odeslání skriptu pro trénování modelu v mnoha různých scénářích ve službě Azure Machine Learning, včetně spuštění HyperDrivu, spuštění kanálu a spuštění AutoML. Objekt Spustit se vytvoří také v případě, že jste submit nebo start_logging s Experiment třídou.

Pokud chcete začít s experimenty a spuštěními, přečtěte si téma

Dědičnost
azureml._run_impl.run_base._RunBase
Run

Konstruktor

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

Parametry

experiment
Experiment
Vyžadováno

Obsahující experiment.

run_id
str
Vyžadováno

ID spuštění.

outputs
str
výchozí hodnota: None

Výstupy, které se mají sledovat.

_run_dto
<xref:azureml._restclient.models.run_dto.RunDto>
Vyžadováno

Pouze interní použití.

kwargs
dict
Vyžadováno

Slovník dalších parametrů konfigurace.

Poznámky

Spuštění představuje jednu zkušební verzi experimentu. Objekt Spustit se používá k monitorování asynchronního spouštění zkušební verze, metrik protokolů a ukládání výstupu zkušební verze a k analýze výsledků a přístupových artefaktů vygenerovaných zkušební verzí.

Spuštění se používá uvnitř kódu experimentování k protokolování metrik a artefaktů do služby Historie spuštění.

Spuštění se používá mimo experimenty k monitorování průběhu a k dotazování a analýze metrik a výsledků, které byly generovány.

Funkce Spustit zahrnuje:

  • Ukládání a načítání metrik a dat

  • Nahrávání a stahování souborů

  • Použití značek a podřízené hierarchie pro snadné vyhledávání minulých spuštění

  • Registrace uložených souborů modelu jako modelu, který lze zprovoznit

  • Ukládání, úpravy a načítání vlastností spuštění

  • Načtení aktuálního spuštění ze vzdáleného prostředí pomocí get_context metody

  • Efektivní snímek souboru nebo adresáře pro reprodukovatelnost

Tato třída pracuje s Experiment těmito scénáři:

  • Vytvoření spuštění spuštění spuštěním kódu pomocí submit

  • Interaktivní vytvoření spuštění v poznámkovém bloku pomocí start_logging

  • Protokolování metrik a nahrávání artefaktů v experimentu, například při použití log

  • Čtení metrik a stahování artefaktů při analýze experimentálních výsledků, například při použití get_metrics

Pokud chcete odeslat spuštění, vytvořte konfigurační objekt, který popisuje způsob spuštění experimentu. Tady jsou příklady různých objektů konfigurace, které můžete použít:

  • ScriptRunConfig

  • azureml.train.automl.automlconfig.AutoMLConfig

  • azureml.train.hyperdrive.HyperDriveConfig

  • azureml.pipeline.core.Pipeline

  • azureml.pipeline.core.PublishedPipeline

  • azureml.pipeline.core.PipelineEndpoint

Při trénování experimentu je možné do spuštění přidat následující metriky.

  • Skalár

    • Protokolujte číselnou nebo řetězcovou hodnotu ke spuštění s daným názvem pomocí log. Protokolování metriky ke spuštění způsobí, že se metrika uloží do záznamu spuštění v experimentu. Stejnou metriku můžete protokolovat vícekrát během běhu a výsledek se považuje za vektor dané metriky.

    • Příklad: run.log("accuracy", 0.95)

  • Seznam

    • Protokolujte seznam hodnot ke spuštění s daným názvem pomocí log_list.

    • Příklad: run.log_list("accuracies", [0.6, 0.7, 0.87])

  • Řádek

    • Použití log_row vytvoří metriku s více sloupci, jak je popsáno v části kwargs. Každý pojmenovaný parametr vygeneruje sloupec se zadanou hodnotou. log_row lze volat jednou za účelem protokolování libovolné řazené kolekce členů nebo vícekrát ve smyčce, aby se vygenerovala úplná tabulka.

    • Příklad: run.log_row("Y over X", x=1, y=0.4)

  • Tabulka

    • Log adictionary object to the run with the given name using log_table.

    • Příklad: run.log_table("Y over X", {"x":[1, 2, 3], "y":[0.6, 0.7, 0.89]})

  • Image

    • Zaznamenejte image ke záznamu spuštění. Slouží log_image k protokolování souboru obrázku nebo diagramu matplotlib ke spuštění. Tyto obrázky budou viditelné a srovnatelné v záznamu spuštění.

    • Příklad: run.log_image("ROC", path)

Metody

add_properties

Přidejte do spuštění neměnné vlastnosti.

Značky a vlastnosti (dikt[str, str]) se liší v jejich proměnlivosti. Vlastnosti jsou neměnné, takže vytvoří trvalý záznam pro účely auditování. Značky jsou proměnlivé. Další informace o práci se značkami a vlastnostmi najdete v tématu Značky a hledání spuštění.

add_type_provider

Háček rozšiřitelnosti pro vlastní typy spuštění uložené v historii spuštění

cancel

Označte spuštění jako zrušené.

Pokud existuje přidružená úloha s polem sady cancel_uri, ukončete tuto úlohu také.

child_run

Vytvořte podřízené spuštění.

clean

Odeberte soubory odpovídající aktuálnímu spuštění v cíli zadaném v konfiguraci spuštění.

complete

Počkejte na zpracování fronty úkolů.

Pak se spuštění označí jako dokončené. Obvykle se používá ve scénářích interaktivního poznámkového bloku.

create_children

Vytvořte jedno nebo mnoho podřízených spuštění.

download_file

Stáhněte si přidružený soubor z úložiště.

download_files

Stáhněte soubory z dané předpony úložiště (název složky) nebo celého kontejneru, pokud není zadána předpona.

fail

Označte spuštění jako neúspěšné.

Volitelně můžete nastavit vlastnost Error spuštění se zprávou nebo výjimkou předanou .error_details

flush

Počkejte na zpracování fronty úloh.

get

Získejte spuštění pro tento pracovní prostor s ID spuštění.

get_all_logs

Stáhněte všechny protokoly pro spuštění do adresáře.

get_children

Získejte všechny podřízené položky pro aktuální spuštění vybrané zadanými filtry.

get_context

Vrátí aktuální kontext služby.

Pomocí této metody načtěte aktuální kontext služby pro protokolování metrik a nahrávání souborů. Pokud allow_offline je true (výchozí), akce vůči objektu Spustit se vytisknou na standardní hodnotu.

get_detailed_status

Načtěte nejnovější stav spuštění. Pokud je stav spuštění ve frontě, zobrazí se podrobnosti.

get_details

Získejte definici, informace o stavu, aktuální soubory protokolu a další podrobnosti o spuštění.

get_details_with_logs

Návratový stav spuštění, včetně obsahu souboru protokolu.

get_environment

Získejte definici prostředí používanou tímto spuštěním.

get_file_names

Zobrazte seznam souborů uložených v přidružení ke spuštění.

get_metrics

Načtěte metriky zaznamenané ke spuštění.

Pokud recursive je ve výchozím nastavení true (Nepravda), načtěte metriky pro spuštění v podstromu daného spuštění.

get_properties

Načtěte nejnovější vlastnosti spuštění ze služby.

get_secret

Získejte hodnotu tajného kódu z kontextu spuštění.

Získejte hodnotu tajného kódu pro zadaný název. Název tajného kódu odkazuje na hodnotu uloženou v Azure Key Vault přidružené k vašemu pracovnímu prostoru. Příklad práce s tajnými kódy najdete v tématu Použití tajných kódů v trénovacích spuštěních.

get_secrets

Získejte hodnoty tajných kódů pro daný seznam názvů tajných kódů.

Získejte slovník nalezených a nenalezených tajných kódů pro seznam zadaných názvů. Každý název tajného kódu odkazuje na hodnotu uloženou v Azure Key Vault přidružené k vašemu pracovnímu prostoru. Příklad práce s tajnými kódy najdete v tématu Použití tajných kódů v trénovacích spuštěních.

get_snapshot_id

Získejte nejnovější ID snímku.

get_status

Načtěte nejnovější stav spuštění.

Vrácené běžné hodnoty zahrnují "Spuštěno", "Dokončeno" a "Selhání".

get_submitted_run

ZASTARALÉ. Použijte get_context.

Získejte odeslané spuštění pro tento experiment.

get_tags

Načtěte nejnovější sadu proměnlivých značek na spuštění ze služby.

list

Získejte seznam spuštění v experimentu určeném volitelnými filtry.

list_by_compute

Získejte seznam spuštění ve výpočetním prostředí určeném volitelnými filtry.

log

Zapíše do spuštění hodnotu metriky s daným názvem.

log_accuracy_table

Protokolujte tabulku přesnosti do úložiště artefaktů.

Metrika tabulky přesnosti je multi-use, non-skalární metrika, která se dá použít k vytvoření více typů spojnicových grafů, které se neustále liší v prostoru predikovaných pravděpodobností. Příklady těchto grafů jsou ROC, přesnost a zvednutí křivek.

Výpočet tabulky přesnosti je podobný výpočtu křivky ROC. Křivka ROC ukládá skutečné kladné sazby a falešně pozitivní sazby na mnoha různých prahových hodnotách pravděpodobnosti. Tabulka přesnosti ukládá nezpracovaný počet pravdivě pozitivních výsledků, falešně pozitivních výsledků, pravdivě negativních výsledků a falešně negativních výsledků v mnoha prahových hodnotách pravděpodobnosti.

Pro výběr prahových hodnot se používají dvě metody: "pravděpodobnost" a "percentil". Liší se v tom, jak vzorkují z prostoru předpovídané pravděpodobnosti.

Prahové hodnoty pravděpodobnosti jsou rovnoměrně rozložené prahové hodnoty mezi 0 a 1. Pokud je NUM_POINTS 5, prahové hodnoty pravděpodobnosti budou [0,0, 0,25, 0,5, 0,75, 1,0].

Prahové hodnoty percentilu jsou rozmístěny v závislosti na rozdělení predikovaných pravděpodobností. Každá prahová hodnota odpovídá percentilu dat při prahové hodnotě pravděpodobnosti. Pokud je například NUM_POINTS 5, pak by první prahová hodnota byla na 0. percentilu, druhá v 25. percentilu, třetí na 50. a tak dále.

Tabulky pravděpodobnosti a percentilové tabulky jsou 3D seznamy, kde první dimenze představuje popisek třídy, druhá dimenze představuje vzorek na jedné prahové hodnotě (škáluje se NUM_POINTS) a třetí dimenze má vždy 4 hodnoty: TP, FP, TN, FN a vždy v tomto pořadí.

Konfuzní hodnoty (TP, FP, TN, FN) se počítají s jednou vs. strategií rest. Další podrobnosti najdete na následujícím odkazu: https://en.wikipedia.org/wiki/Multiclass_classification

N = # vzorků v ověřovací datové sadě (v příkladu 200) M = # prahové hodnoty = # vzorky odebrané z prostoru pravděpodobnosti (5 v příkladu) C = # třídy v plné datové sadě (3 v příkladu)

Některé invarianty tabulky přesnosti:

  • TP + FP + TN + FN = N pro všechny prahové hodnoty pro všechny třídy
  • TP + FN je stejné ve všech prahových hodnotách pro libovolnou třídu.
  • TN + FP je stejná u všech prahových hodnot pro libovolnou třídu
  • Tabulky pravděpodobnosti a percentilové tabulky mají tvar [C, M, 4]

Poznámka: M může být libovolná hodnota a řídí rozlišení grafů, které jsou nezávislé na datové sadě, je definován při výpočtu metrik a vymění prostor úložiště, dobu výpočtu a rozlišení.

Popisky tříd by měly být řetězce, konfuzní hodnoty by měly být celá čísla a prahové hodnoty by měly být plovoucí.

log_confusion_matrix

Zapíše do úložiště artefaktů konfuzní matici.

Zaprotokoluje obálku kolem konfuzní matice sklearnu. Data metrik obsahují popisky tříd a 2D seznam pro samotnou matici. Další podrobnosti o výpočtu metriky najdete na následujícím odkazu: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html

log_image

Protokolujte metriku image do záznamu spuštění.

log_list

Protokolujte seznam hodnot metrik do spuštění s daným názvem.

log_predictions

Protokolování predikcí do úložiště artefaktů

Zaznamená se do protokolu skóre metriky, které lze použít k porovnání rozdělení skutečných cílových hodnot s rozdělením predikovaných hodnot pro regresní úlohu.

Předpovědi jsou binární a směrodatné odchylky se počítají pro chybové úsečky spojnicového grafu.

log_residuals

Protokolování reziduí do úložiště artefaktů

To zaznamená data potřebná k zobrazení histogramu reziduí pro regresní úlohu. Rezidua jsou předpovězena - skutečná.

Měl by existovat ještě jeden okraj než počet počtů. Podívejte se na dokumentaci k histogramu numpy, kde najdete příklady použití počtu a hran k reprezentaci histogramu. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html

log_row

Protokolujte metriku řádku ke spuštění s daným názvem.

log_table

Protokolujte metriku tabulky ke spuštění s daným názvem.

register_model

Zaregistrujte model pro zprovoznění.

remove_tags

Odstraňte seznam ztlumitelných značek v tomto spuštění.

restore_snapshot

Obnovte snímek jako soubor ZIP. Vrátí cestu k souboru ZIP.

set_tags

Přidejte nebo upravte sadu značek za běhu. Značky, které nejsou předány ve slovníku, zůstanou nedotčené.

Můžete také přidat jednoduché značky řetězců. Když se tyto značky zobrazí ve slovníku značek jako klíče, mají hodnotu None ( Žádné). Další informace najdete v tématu Označování a hledání spuštění.

start

Označte spuštění jako spuštěné.

Obvykle se používá v pokročilých scénářích, když spuštění vytvořil jiný objekt actor.

submit_child

Odešlete experiment a vrátíte aktivní podřízené spuštění.

tag

Označte spuštění řetězcem pomocí klíče řetězce a volitelné hodnoty řetězce.

take_snapshot

Uložte snímek vstupního souboru nebo složky.

upload_file

Nahrajte soubor do záznamu spuštění.

upload_files

Nahrajte soubory do záznamu spuštění.

upload_folder

Nahrajte zadanou složku do názvu dané předpony.

wait_for_completion

Počkejte na dokončení tohoto spuštění. Vrátí stavový objekt po čekání.

add_properties

Přidejte do spuštění neměnné vlastnosti.

Značky a vlastnosti (dikt[str, str]) se liší v jejich proměnlivosti. Vlastnosti jsou neměnné, takže vytvoří trvalý záznam pro účely auditování. Značky jsou proměnlivé. Další informace o práci se značkami a vlastnostmi najdete v tématu Značky a hledání spuštění.

add_properties(properties)

Parametry

properties
dict
Vyžadováno

Skryté vlastnosti uložené v objektu run.

add_type_provider

Háček rozšiřitelnosti pro vlastní typy spuštění uložené v historii spuštění

static add_type_provider(runtype, run_factory)

Parametry

runtype
str
Vyžadováno

Hodnota Run.type, pro kterou bude vyvolána továrna. Mezi příklady patří hyperdrive nebo azureml.scriptrun, ale můžete ho rozšířit vlastními typy.

run_factory
<xref:function>
Vyžadováno

Funkce s podpisem (Experiment, RunDto) –> Spuštění, které se má vyvolat při výpisu spuštění.

cancel

Označte spuštění jako zrušené.

Pokud existuje přidružená úloha s polem sady cancel_uri, ukončete tuto úlohu také.

cancel()

child_run

Vytvořte podřízené spuštění.

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

Parametry

name
str
výchozí hodnota: None

Volitelný název podřízeného spuštění, obvykle určený pro "část".

run_id
str
výchozí hodnota: None

Volitelné ID spuštění pro podřízenou položku, jinak se automaticky vygeneruje. Tento parametr obvykle není nastavený.

outputs
str
výchozí hodnota: None

Volitelné výstupy adresáře pro sledování podřízenosti.

Návraty

Podřízený běh.

Návratový typ

Run

Poznámky

Slouží k izolaci části běhu do pododdílu. To lze provést pro identifikovatelné "části" běhu, které jsou zajímavé k oddělení, nebo zachytávání nezávislých metrik v rámci meziprocesu.

Pokud je pro podřízené spuštění nastavený výstupní adresář, obsah tohoto adresáře se po dokončení podřízeného spuštění nahraje do podřízeného záznamu spuštění.

clean

Odeberte soubory odpovídající aktuálnímu spuštění v cíli zadaném v konfiguraci spuštění.

clean()

Návraty

Seznam odstraněných souborů

Návratový typ

complete

Počkejte na zpracování fronty úkolů.

Pak se spuštění označí jako dokončené. Obvykle se používá ve scénářích interaktivního poznámkového bloku.

complete(_set_status=True)

Parametry

_set_status
bool
výchozí hodnota: True

Určuje, jestli se má událost stavu odeslat pro sledování.

create_children

Vytvořte jedno nebo mnoho podřízených spuštění.

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

Parametry

count
int
výchozí hodnota: None

Volitelný počet podřízených položek, které chcete vytvořit.

tag_key
str
výchozí hodnota: None

Volitelný klíč pro naplnění položky Značky ve všech vytvořených podřízených objektech.

tag_Values
Vyžadováno

Volitelný seznam hodnot, které se budou mapovat na značky[tag_key] pro seznam vytvořených spuštění.

tag_values
výchozí hodnota: None

Návraty

Seznam podřízených spuštění

Návratový typ

Poznámky

Musí být zadán parametr count NEBO parametry tag_key A tag_values .

download_file

Stáhněte si přidružený soubor z úložiště.

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

Parametry

name
str
Vyžadováno

Název artefaktu, který se má stáhnout.

output_file_path
str
Vyžadováno

Místní cesta, kam chcete artefakt uložit.

download_files

Stáhněte soubory z dané předpony úložiště (název složky) nebo celého kontejneru, pokud není zadána předpona.

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

Parametry

prefix
str
Vyžadováno

Předpona cesty k souboru v kontejneru, ze které chcete stáhnout všechny artefakty.

output_directory
str
Vyžadováno

Volitelný adresář, který všechny cesty artefaktů používají jako předponu.

output_paths
[str]
Vyžadováno

Volitelné cesty k souborům, do kterých se mají ukládat stažené artefakty. Měla by být jedinečná a měla by odpovídat délce cest.

batch_size
int
Vyžadováno

Počet souborů ke stažení na dávku Výchozí hodnota je 100 souborů.

append_prefix
bool
Vyžadováno

Volitelný příznak, zda se má připojit zadaná předpona z konečné výstupní cesty k souboru. Pokud je hodnota False, odebere se předpona z cesty k výstupnímu souboru.

timeout_seconds
int
Vyžadováno

Časový limit pro stahování souborů.

fail

Označte spuštění jako neúspěšné.

Volitelně můžete nastavit vlastnost Error spuštění se zprávou nebo výjimkou předanou .error_details

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

Parametry

error_details
str nebo BaseException
výchozí hodnota: None

Volitelné podrobnosti o chybě.

error_code
str
výchozí hodnota: None

Volitelný kód chyby pro klasifikaci chyb.

_set_status
bool
výchozí hodnota: True

Určuje, jestli se má událost stavu odeslat ke sledování.

flush

Počkejte na zpracování fronty úloh.

flush(timeout_seconds=300)

Parametry

timeout_seconds
int
výchozí hodnota: 300

Jak dlouho čekat (v sekundách) na zpracování fronty úloh

get

Získejte spuštění pro tento pracovní prostor s ID spuštění.

static get(workspace, run_id)

Parametry

workspace
Workspace
Vyžadováno

Obsahuje pracovní prostor.

run_id
string
Vyžadováno

ID spuštění.

Návraty

Odeslané spuštění.

Návratový typ

Run

get_all_logs

Stáhněte všechny protokoly pro spuštění do adresáře.

get_all_logs(destination=None)

Parametry

destination
str
výchozí hodnota: None

Cílová cesta k ukládání protokolů. Pokud není zadaný, vytvoří se v adresáři projektu adresář pojmenovaný jako ID spuštění.

Návraty

Seznam stažených protokolů

Návratový typ

get_children

Získejte všechny podřízené položky pro aktuální spuštění vybrané zadanými filtry.

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

Parametry

recursive
bool
výchozí hodnota: False

Určuje, zda se má provést rekurse prostřednictvím všech potomků.

tags
str nebo dict
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění odpovídající zadané "tag" nebo {"tag": "value"}.

properties
str nebo dict
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění odpovídající zadané vlastnosti nebo {"vlastnost": "value"}.

type
str
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění odpovídající tomuto typu.

status
str
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění se zadaným stavem "status".

_rehydrate_runs
bool
výchozí hodnota: True

Určuje, jestli se má vytvořit instance spuštění původního typu nebo základního spuštění.

Návraty

Seznam Run objektů.

Návratový typ

get_context

Vrátí aktuální kontext služby.

Pomocí této metody načtěte aktuální kontext služby pro protokolování metrik a nahrávání souborů. Pokud allow_offline je true (výchozí), akce vůči objektu Spustit se vytisknou na standardní hodnotu.

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

Parametry

cls
Vyžadováno

Označuje metodu třídy.

allow_offline
bool
výchozí hodnota: True

Povolte kontextu služby návrat do offline režimu, aby se trénovací skript mohl testovat místně bez odeslání úlohy pomocí sady SDK. True ve výchozím nastavení.

kwargs
dict
Vyžadováno

Slovník dalších parametrů.

used_for_context_manager
výchozí hodnota: False

Návraty

Odeslané spuštění.

Návratový typ

Run

Poznámky

Tato funkce se běžně používá k načtení ověřeného objektu Run uvnitř skriptu, který se má odeslat ke spuštění prostřednictvím experiment.submit(). Tento objekt spuštění je ověřený kontext pro komunikaci se službami Azure Machine Learning a koncepční kontejner, ve kterém jsou obsaženy metriky, soubory (artefakty) a modely.


   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

Načtěte nejnovější stav spuštění. Pokud je stav spuštění ve frontě, zobrazí se podrobnosti.

get_detailed_status()

Návraty

Nejnovější stav a podrobnosti

Návratový typ

Poznámky

  • stav: Aktuální stav spuštění. Stejná hodnota jako vrácená z get_status().

  • podrobnosti: Podrobné informace o aktuálním stavu.


   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

Získejte definici, informace o stavu, aktuální soubory protokolu a další podrobnosti o spuštění.

get_details()

Návraty

Vrácení podrobností o spuštění

Návratový typ

Poznámky

Vrácený slovník obsahuje následující páry klíč-hodnota:

  • runId: ID tohoto spuštění.

  • Cíl

  • stav: Aktuální stav spuštění. Stejná hodnota jako vrácená z get_status().

  • startTimeUtc: čas UTC spuštění v ISO8601.

  • endTimeUtc: Čas UTC dokončení tohoto spuštění (dokončeno nebo neúspěšné) v ISO8601.

    Tento klíč neexistuje, pokud spuštění stále probíhá.

  • properties: Neměnné páry klíč-hodnota přidružené ke spuštění. Výchozí vlastnosti zahrnují ID snímku spuštění a informace o úložišti Git, ze kterého se spuštění vytvořilo (pokud existuje). Do spuštění lze přidat další vlastnosti pomocí add_properties.

  • inputDatasets: Vstupní datové sady přidružené ke spuštění.

  • outputDatasets: Výstupní datové sady přidružené ke spuštění

  • 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

Návratový stav spuštění, včetně obsahu souboru protokolu.

get_details_with_logs()

Návraty

Vrátí stav spuštění s obsahem souboru protokolu.

Návratový typ

get_environment

Získejte definici prostředí používanou tímto spuštěním.

get_environment()

Návraty

Vrátí objekt prostředí.

Návratový typ

get_file_names

Zobrazte seznam souborů uložených v přidružení ke spuštění.

get_file_names()

Návraty

Seznam cest pro existující artefakty

Návratový typ

get_metrics

Načtěte metriky zaznamenané ke spuštění.

Pokud recursive je ve výchozím nastavení true (Nepravda), načtěte metriky pro spuštění v podstromu daného spuštění.

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

Parametry

name
str
výchozí hodnota: None

Název metriky

recursive
bool
výchozí hodnota: False

Určuje, zda se má provést rekurse prostřednictvím všech potomků.

run_type
str
výchozí hodnota: None
populate
bool
výchozí hodnota: False

Určuje, jestli se má načíst obsah externích dat propojených s metrikou.

Návraty

Slovník obsahující metriky uživatelů

Návratový typ

Poznámky


   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

Načtěte nejnovější vlastnosti spuštění ze služby.

get_properties()

Návraty

Vlastnosti spuštění.

Návratový typ

Poznámky

Vlastnosti jsou neměnné systémové vygenerované informace, jako je doba trvání, datum spuštění, uživatel a vlastní vlastnosti přidané metodou add_properties . Další informace najdete v tématu Označení a vyhledání spuštění.

Pokud jsou zdrojové soubory uložené v místním úložišti Git, uloží se při odesílání úlohy do služby Azure Machine Learning informace o úložišti jako vlastnosti. Tyto vlastnosti Gitu se přidají při vytváření spuštění nebo volání Experiment.submit. Další informace o vlastnostech Gitu najdete v tématu Integrace Gitu pro Azure Machine Learning.

get_secret

Získejte hodnotu tajného kódu z kontextu spuštění.

Získejte hodnotu tajného kódu pro zadaný název. Název tajného kódu odkazuje na hodnotu uloženou v Azure Key Vault přidružené k vašemu pracovnímu prostoru. Příklad práce s tajnými kódy najdete v tématu Použití tajných kódů v trénovacích spuštěních.

get_secret(name)

Parametry

name
str
Vyžadováno

Název tajného kódu, pro který chcete vrátit tajný kód.

Návraty

Hodnota tajného kódu.

Návratový typ

str

get_secrets

Získejte hodnoty tajných kódů pro daný seznam názvů tajných kódů.

Získejte slovník nalezených a nenalezených tajných kódů pro seznam zadaných názvů. Každý název tajného kódu odkazuje na hodnotu uloženou v Azure Key Vault přidružené k vašemu pracovnímu prostoru. Příklad práce s tajnými kódy najdete v tématu Použití tajných kódů v trénovacích spuštěních.

get_secrets(secrets)

Parametry

secrets
list[str]
Vyžadováno

Seznam názvů tajných kódů, pro které se mají vrátit tajné hodnoty.

Návraty

Vrátí slovník nalezených a nenalezených tajných kódů.

Návratový typ

dict[<xref:str: str>]

get_snapshot_id

Získejte nejnovější ID snímku.

get_snapshot_id()

Návraty

Nejnovější ID snímku.

Návratový typ

str

get_status

Načtěte nejnovější stav spuštění.

Vrácené běžné hodnoty zahrnují "Spuštěno", "Dokončeno" a "Selhání".

get_status()

Návraty

Nejnovější stav.

Návratový typ

str

Poznámky

  • NotStarted – Jedná se o dočasné objekty spuštění na straně klienta před odesláním cloudu.

  • Spuštění – Spuštění se začalo zpracovávat v cloudu. Volající má v tuto chvíli ID spuštění.

  • Zřizování – vráceno při vytváření výpočetních prostředků na vyžádání pro dané odeslání úlohy.

  • Příprava – Probíhá příprava prostředí spuštění:

    • sestavení image dockeru

    • Nastavení prostředí conda

  • Ve frontě – úloha je zařazena do fronty v cílovém výpočetním objektu. Například ve službě BatchAI je úloha ve frontě

    při čekání na připravenost všech požadovaných uzlů.

  • Spuštěno – úloha začala běžet v cílovém výpočetním objektu.

  • Finalizace – Kód uživatele byl dokončen a spuštění je ve fázích následného zpracování.

  • CancelRequested – Zrušení bylo požadováno pro úlohu.

  • Dokončeno – Spuštění bylo úspěšně dokončeno. To zahrnuje jak uživatelský kód, tak spuštění.

    fáze následného zpracování.

  • Selhání – Spuštění se nezdařilo. Vlastnost Error při spuštění obvykle poskytne podrobnosti o tom, proč.

  • Zrušeno – následuje žádost o zrušení a značí, že se spuštění úspěšně zrušilo.

  • Nereaguje – U spuštění s povolenými prezenčních signálů se v poslední době neodesílaly žádné prezenční signály.


   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

ZASTARALÉ. Použijte get_context.

Získejte odeslané spuštění pro tento experiment.

get_submitted_run(**kwargs)

Návraty

Odeslané spuštění.

Návratový typ

Run

get_tags

Načtěte nejnovější sadu proměnlivých značek na spuštění ze služby.

get_tags()

Návraty

Značky uložené na objektu run.

Návratový typ

list

Získejte seznam spuštění v experimentu určeném volitelnými filtry.

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

Parametry

experiment
Experiment
Vyžadováno

Obsahující experiment.

type
str
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění odpovídající zadanému typu.

tags
str nebo dict
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění odpovídající zadané "tag" nebo {"tag": "value"}.

properties
str nebo dict
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění odpovídající zadané vlastnosti nebo {"vlastnost": "value"}.

status
str
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění se zadaným stavem "status".

include_children
bool
výchozí hodnota: False

Pokud je nastavená hodnota true, načtěte všechna spuštění, nejen ty nejvyšší úrovně.

_rehydrate_runs
bool
výchozí hodnota: True

Pokud je nastavená hodnota True (ve výchozím nastavení), použije zaregistrovaný zprostředkovatel k obnovení objektu pro tento typ místo základního spuštění.

Návraty

Seznamspuštěních

Návratový typ

Poznámky

Následující příklad kódu ukazuje některé použití 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

Získejte seznam spuštění ve výpočetním prostředí určeném volitelnými filtry.

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

Parametry

compute
ComputeTarget
Vyžadováno

Obsahující výpočetní prostředky.

type
str
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění odpovídající zadanému typu.

tags
str nebo dict
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění odpovídající zadané "tag" nebo {"tag": "value"}.

properties
str nebo dict
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění odpovídající zadané vlastnosti nebo {"vlastnost": "value"}.

status
str
výchozí hodnota: None

Pokud je zadáno, vrátí spuštění se zadaným stavem "status". Pouze povolené hodnoty jsou "Spuštěno" a "Zařazeno do fronty".

Návraty

generátor ~_restclient.models.RunDto

Návratový typ

<xref:builtin.generator>

log

Zapíše do spuštění hodnotu metriky s daným názvem.

log(name, value, description='', step=None)

Parametry

name
str
Vyžadováno

Název metriky.

value
Vyžadováno

Hodnota, která se má publikovat do služby.

description
str
Vyžadováno

Volitelný popis metriky.

step
int
výchozí hodnota: None

Volitelná osa pro určení pořadí hodnot v rámci metriky.

Poznámky

Protokolování metriky ke spuštění způsobí, že se metrika uloží do záznamu spuštění v experimentu. Stejnou metriku můžete protokolovat vícekrát během spuštění, což je výsledek považován za vektor této metriky. Pokud je pro metriku zadaný krok, musí být zadán pro všechny hodnoty.

log_accuracy_table

Protokolujte tabulku přesnosti do úložiště artefaktů.

Metrika tabulky přesnosti je multi-use, non-skalární metrika, která se dá použít k vytvoření více typů spojnicových grafů, které se neustále liší v prostoru predikovaných pravděpodobností. Příklady těchto grafů jsou ROC, přesnost a zvednutí křivek.

Výpočet tabulky přesnosti je podobný výpočtu křivky ROC. Křivka ROC ukládá skutečné kladné sazby a falešně pozitivní sazby na mnoha různých prahových hodnotách pravděpodobnosti. Tabulka přesnosti ukládá nezpracovaný počet pravdivě pozitivních výsledků, falešně pozitivních výsledků, pravdivě negativních výsledků a falešně negativních výsledků v mnoha prahových hodnotách pravděpodobnosti.

Pro výběr prahových hodnot se používají dvě metody: "pravděpodobnost" a "percentil". Liší se v tom, jak vzorkují z prostoru předpovídané pravděpodobnosti.

Prahové hodnoty pravděpodobnosti jsou rovnoměrně rozložené prahové hodnoty mezi 0 a 1. Pokud je NUM_POINTS 5, prahové hodnoty pravděpodobnosti budou [0,0, 0,25, 0,5, 0,75, 1,0].

Prahové hodnoty percentilu jsou rozmístěny v závislosti na rozdělení predikovaných pravděpodobností. Každá prahová hodnota odpovídá percentilu dat při prahové hodnotě pravděpodobnosti. Pokud je například NUM_POINTS 5, pak by první prahová hodnota byla na 0. percentilu, druhá v 25. percentilu, třetí na 50. a tak dále.

Tabulky pravděpodobnosti a percentilové tabulky jsou 3D seznamy, kde první dimenze představuje popisek třídy, druhá dimenze představuje vzorek na jedné prahové hodnotě (škáluje se NUM_POINTS) a třetí dimenze má vždy 4 hodnoty: TP, FP, TN, FN a vždy v tomto pořadí.

Konfuzní hodnoty (TP, FP, TN, FN) se počítají s jednou vs. strategií rest. Další podrobnosti najdete na následujícím odkazu: https://en.wikipedia.org/wiki/Multiclass_classification

N = # vzorků v ověřovací datové sadě (v příkladu 200) M = # prahové hodnoty = # vzorky odebrané z prostoru pravděpodobnosti (5 v příkladu) C = # třídy v plné datové sadě (3 v příkladu)

Některé invarianty tabulky přesnosti:

  • TP + FP + TN + FN = N pro všechny prahové hodnoty pro všechny třídy
  • TP + FN je stejné ve všech prahových hodnotách pro libovolnou třídu.
  • TN + FP je stejná u všech prahových hodnot pro libovolnou třídu
  • Tabulky pravděpodobnosti a percentilové tabulky mají tvar [C, M, 4]

Poznámka: M může být libovolná hodnota a řídí rozlišení grafů, které jsou nezávislé na datové sadě, je definován při výpočtu metrik a vymění prostor úložiště, dobu výpočtu a rozlišení.

Popisky tříd by měly být řetězce, konfuzní hodnoty by měly být celá čísla a prahové hodnoty by měly být plovoucí.

log_accuracy_table(name, value, description='')

Parametry

name
str
Vyžadováno

Název tabulky přesnosti.

value
str nebo dict
Vyžadováno

JSON obsahující vlastnosti názvu, verze a dat

description
str
Vyžadováno

Volitelný popis metriky.

Poznámky

Příklad platné hodnoty 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

Zapíše do úložiště artefaktů konfuzní matici.

Zaprotokoluje obálku kolem konfuzní matice sklearnu. Data metrik obsahují popisky tříd a 2D seznam pro samotnou matici. Další podrobnosti o výpočtu metriky najdete na následujícím odkazu: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html

log_confusion_matrix(name, value, description='')

Parametry

name
str
Vyžadováno

Název konfuzní matice.

value
str nebo dict
Vyžadováno

JSON obsahující vlastnosti názvu, verze a dat

description
str
Vyžadováno

Volitelný popis metriky.

Poznámky

Příklad platné hodnoty 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

Protokolujte metriku image do záznamu spuštění.

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

Parametry

name
str
Vyžadováno

Název metriky

path
str
Vyžadováno

Cesta nebo stream obrázku.

plot
<xref:matplotlib.pyplot>
Vyžadováno

Graf, který se má protokolovat jako obrázek.

description
str
Vyžadováno

Volitelný popis metriky.

Poznámky

Tuto metodu použijte k protokolování souboru image nebo diagramu matplotlib do spuštění. Tyto image budou viditelné a srovnatelné v záznamu spuštění.

log_list

Protokolujte seznam hodnot metrik do spuštění s daným názvem.

log_list(name, value, description='')

Parametry

name
str
Vyžadováno

Název metriky.

value
list
Vyžadováno

Hodnoty metriky.

description
str
Vyžadováno

Volitelný popis metriky.

log_predictions

Protokolování predikcí do úložiště artefaktů

Zaznamená se do protokolu skóre metriky, které lze použít k porovnání rozdělení skutečných cílových hodnot s rozdělením predikovaných hodnot pro regresní úlohu.

Předpovědi jsou binární a směrodatné odchylky se počítají pro chybové úsečky spojnicového grafu.

log_predictions(name, value, description='')

Parametry

name
str
Vyžadováno

Název predikcí.

value
str nebo dict
Vyžadováno

JSON obsahující vlastnosti názvu, verze a dat

description
str
Vyžadováno

Volitelný popis metriky.

Poznámky

Příklad platné hodnoty 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

Protokolování reziduí do úložiště artefaktů

To zaznamená data potřebná k zobrazení histogramu reziduí pro regresní úlohu. Rezidua jsou předpovězena - skutečná.

Měl by existovat ještě jeden okraj než počet počtů. Podívejte se na dokumentaci k histogramu numpy, kde najdete příklady použití počtu a hran k reprezentaci histogramu. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html

log_residuals(name, value, description='')

Parametry

name
str
Vyžadováno

Název reziduí.

value
str nebo dict
Vyžadováno

JSON obsahující vlastnosti názvu, verze a dat

description
str
Vyžadováno

Volitelný popis metriky.

Poznámky

Příklad platné hodnoty 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

Protokolujte metriku řádku ke spuštění s daným názvem.

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

Parametry

name
str
Vyžadováno

Název metriky

description
str
výchozí hodnota: None

Volitelný popis metriky.

kwargs
dict
Vyžadováno

Slovník dalších parametrů. V tomto případě sloupce metriky.

Poznámky

Použití log_row vytvoří metriku tabulky se sloupci popsanými v kwargs. Každý pojmenovaný parametr vygeneruje sloupec se zadanou hodnotou. log_row může být volána jednou pro protokolování libovolné kolekce členů nebo vícekrát ve smyčce pro vygenerování úplné tabulky.


   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

Protokolujte metriku tabulky ke spuštění s daným názvem.

log_table(name, value, description='')

Parametry

name
str
Vyžadováno

Název metriky

value
dict
Vyžadováno

Hodnota tabulky metriky, slovník, ve kterém jsou sloupce, které se mají do služby publikovat.

description
str
Vyžadováno

Volitelný popis metriky.

register_model

Zaregistrujte model pro zprovoznění.

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
Vyžadováno

Název modelu

model_path
str
výchozí hodnota: None

Relativní cloudová cesta k modelu, například "outputs/modelname". Pokud není zadán (Žádný), model_name použije se jako cesta.

tags
dict[str, str]
výchozí hodnota: None

Slovník značek klíčových hodnot, které se mají přiřadit k modelu.

properties
dict[str, str]
výchozí hodnota: None

Slovník vlastností klíčových hodnot, které chcete přiřadit k modelu. Tyto vlastnosti nelze po vytvoření modelu změnit, ale je možné přidat nové páry hodnot klíče.

model_framework
str
výchozí hodnota: None

Architektura modelu, který se má zaregistrovat. Aktuálně podporované architektury: TensorFlow, ScikitLearn, Onnx, Custom, Multi

model_framework_version
str
výchozí hodnota: None

Verze architektury registrovaného modelu.

description
str
výchozí hodnota: None

Volitelný popis modelu.

datasets
list[(str, AbstractDataset)]
výchozí hodnota: None

Seznam řazených kolekcí členů, kde první prvek popisuje relaci modelu datové sady a druhý prvek je datová sada.

sample_input_dataset
AbstractDataset
výchozí hodnota: None

Nepovinný parametr. Ukázková vstupní datová sada pro registrovaný model

sample_output_dataset
AbstractDataset
výchozí hodnota: None

Nepovinný parametr. Ukázková výstupní datová sada pro registrovaný model

resource_configuration
ResourceConfiguration
výchozí hodnota: None

Nepovinný parametr. Konfigurace prostředků pro spuštění registrovaného modelu

kwargs
dict
Vyžadováno

Volitelné parametry.

Návraty

Registrovaný model.

Návratový typ

Poznámky


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

remove_tags

Odstraňte seznam ztlumitelných značek v tomto spuštění.

remove_tags(tags)

Parametry

tags
list
Vyžadováno

Seznam značek, které chcete odebrat.

Návraty

Značky uložené na objektu run

restore_snapshot

Obnovte snímek jako soubor ZIP. Vrátí cestu k souboru ZIP.

restore_snapshot(snapshot_id=None, path=None)

Parametry

snapshot_id
str
výchozí hodnota: None

ID snímku, které chcete obnovit. Nejnovější se používá, pokud není zadán.

path
str
výchozí hodnota: None

Cesta, kam se stažený zip uloží.

Návraty

Cesta.

Návratový typ

str

set_tags

Přidejte nebo upravte sadu značek za běhu. Značky, které nejsou předány ve slovníku, zůstanou nedotčené.

Můžete také přidat jednoduché značky řetězců. Když se tyto značky zobrazí ve slovníku značek jako klíče, mají hodnotu None ( Žádné). Další informace najdete v tématu Označování a hledání spuštění.

set_tags(tags)

Parametry

tags
dict[str] nebo str
Vyžadováno

Značky uložené v objektu run.

start

Označte spuštění jako spuštěné.

Obvykle se používá v pokročilých scénářích, když spuštění vytvořil jiný objekt actor.

start()

submit_child

Odešlete experiment a vrátíte aktivní podřízené spuštění.

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

Parametry

config
object
Vyžadováno

Konfigurace, která se má odeslat.

tags
dict
výchozí hodnota: None

Značky, které se mají přidat do odeslaného spuštění, například {"tag": "value"}.

kwargs
dict
Vyžadováno

Další parametry použité v funkci submit pro konfigurace.

Návraty

Spustit objekt.

Návratový typ

Run

Poznámky

Submit je asynchronní volání platformy Azure Machine Learning ke spuštění zkušební verze na místním nebo vzdáleném hardwaru. V závislosti na konfiguraci se odeslání automaticky připraví spouštěcí prostředí, spustí kód a zachytí zdrojový kód a výsledky do historie spuštění experimentu.

Pokud chcete odeslat experiment, musíte nejprve vytvořit objekt konfigurace popisující způsob spuštění experimentu. Konfigurace závisí na typu požadované zkušební verze.

Příklad odeslání podřízeného experimentu z místního počítače pomocí ScriptRunConfig následujícího postupu:


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

Podrobnosti o konfiguraci spuštění najdete v tématu submit.

tag

Označte spuštění řetězcem pomocí klíče řetězce a volitelné hodnoty řetězce.

tag(key, value=None)

Parametry

key
str
Vyžadováno

Klíč značky

value
str
výchozí hodnota: None

Volitelná hodnota značky

Poznámky

Značky a vlastnosti spuštění jsou slovníky řetězce –> řetězce. Rozdíl mezi nimi je proměnlivost: Značky lze nastavit, aktualizovat a odstranit, zatímco vlastnosti je možné přidat pouze. Díky tomu jsou vlastnosti vhodnější pro triggery chování související se systémem nebo pracovním postupem, zatímco značky jsou obecně uživatelsky přístupné a smysluplné pro uživatele experimentu.


   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

Uložte snímek vstupního souboru nebo složky.

take_snapshot(file_or_folder_path)

Parametry

file_or_folder_path
str
Vyžadováno

Soubor nebo složka obsahující zdrojový kód spuštění.

Návraty

Vrátí ID snímku.

Návratový typ

str

Poznámky

Snímky mají být zdrojovým kódem používaným ke spuštění experimentu. Tyto soubory se ukládají se spuštěním, aby bylo možné zkušební verzi spuštění replikovat v budoucnu.

Poznámka

Snímky se automaticky povolají submit . Obvykle se tato metoda take_snapshot vyžaduje pouze pro interaktivní spuštění (poznámkového bloku).

upload_file

Nahrajte soubor do záznamu spuštění.

upload_file(name, path_or_stream, datastore_name=None)

Parametry

name
str
Vyžadováno

Název souboru, který chcete nahrát.

path_or_stream
str
Vyžadováno

Relativní místní cesta nebo datový proud k souboru, který se má nahrát.

datastore_name
str
Vyžadováno

Volitelný název úložiště dat

Návratový typ

Poznámky


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

Poznámka

Spustí automaticky zachytávání souboru v zadaném výstupním adresáři, ve kterém je výchozí hodnota "./outputs" pro většinu typů spuštění. Použijte upload_file pouze v případě, že je potřeba nahrát další soubory nebo není zadaný výstupní adresář.

upload_files

Nahrajte soubory do záznamu spuštění.

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

Parametry

names
list
Vyžadováno

Názvy souborů, které se mají nahrát. Pokud je nastavená, musí být také nastaveny cesty.

paths
list
Vyžadováno

Relativní místní cesty k souborům, které se mají nahrát. Pokud je nastavená, je nutné názvy.

return_artifacts
bool
Vyžadováno

Označuje, že by se měl vrátit objekt artefaktu pro každý nahraný soubor.

timeout_seconds
int
Vyžadováno

Časový limit pro nahrání souborů

datastore_name
str
Vyžadováno

Volitelný název úložiště dat

Poznámky

upload_files má stejný účinek jako upload_file u samostatných souborů, ale při použití upload_filesexistují výhody výkonu a využití prostředků .


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

Poznámka

Spustí automaticky zachytávání souborů v zadaném výstupním adresáři, což je výchozí hodnota "./outputs" pro většinu typů spuštění. Použijte upload_files pouze v případě, že je potřeba nahrát další soubory nebo není zadaný výstupní adresář.

upload_folder

Nahrajte zadanou složku do názvu dané předpony.

upload_folder(name, path, datastore_name=None)

Parametry

name
str
Vyžadováno

Název složky souborů, které se mají nahrát.

folder
str
Vyžadováno

Relativní místní cesta ke složce, kterou chcete nahrát.

datastore_name
str
Vyžadováno

Volitelný název úložiště dat

Poznámky


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

Poznámka

Spustí automaticky zachytávání souborů v zadaném výstupním adresáři, což je výchozí hodnota "./outputs" pro většinu typů spuštění. Použijte upload_folder pouze v případě, že je potřeba nahrát další soubory nebo není zadán výstupní adresář.

wait_for_completion

Počkejte na dokončení tohoto spuštění. Vrátí stavový objekt po čekání.

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

Parametry

show_output
bool
výchozí hodnota: False

Určuje, zda se má zobrazit výstup spuštění v sys.stdout.

wait_post_processing
bool
výchozí hodnota: False

Určuje, jestli se má po dokončení spuštění počkat na dokončení následného zpracování.

raise_on_error
bool
výchozí hodnota: True

Označuje, jestli je při spuštění ve stavu selhání vyvolána chyba.

Návraty

Stavový objekt.

Návratový typ

Atributy

description

Vrátí popis spuštění.

Volitelný popis spuštění je řetězec určený uživatelem, který je užitečný pro popis spuštění.

Návraty

Popis spuštění

Návratový typ

str

display_name

Vrátí zobrazovaný název spuštění.

Volitelný zobrazovaný název spuštění je řetězec určený uživatelem, který je užitečný pro pozdější identifikaci spuštění.

Návraty

Zobrazovaný název spuštění

Návratový typ

str

experiment

Získejte experiment obsahující spuštění.

Návraty

Načte experiment odpovídající spuštění.

Návratový typ

id

Získejte ID spuštění.

ID spuštění je identifikátor jedinečný v rámci experimentu obsahujícího.

Návraty

ID spuštění.

Návratový typ

str

name

ZASTARALÉ. Použijte display_name.

Volitelný název spuštění je řetězec určený uživatelem, který je užitečný pro pozdější identifikaci spuštění.

Návraty

ID spuštění.

Návratový typ

str

number

Získejte číslo spuštění.

Monotonicky rostoucí číslo představující pořadí spuštění v rámci experimentu.

Návraty

Číslo spuštění.

Návratový typ

int

parent

Načtěte nadřazené spuštění pro toto spuštění ze služby.

Spuštění můžou mít volitelnou nadřazenou položku, což vede k potenciální stromové hierarchii spuštění. Pokud chcete protokolovat metriky do nadřazeného spuštění, použijte log například metodu nadřazeného objektu run.parent.log().

Návraty

Nadřazené spuštění nebo Žádná, pokud není nastavená.

Návratový typ

Run

properties

Vrátí neměnné vlastnosti tohoto spuštění.

Návraty

Místně uložené vlastnosti spuštění v mezipaměti.

Návratový typ

dict[str],
str

Poznámky

Mezi vlastnosti patří neměnné systémové vygenerované informace, jako je doba trvání, datum spuštění, uživatel atd.

status

Vrátí stav objektu spuštění.

tags

V tomto spuštění vrátí sadu ztlumitelných značek.

Návraty

Značky uložené na objektu run.

Návratový typ

type

Získejte typ spuštění.

Označuje, jak se spuštění vytvořilo nebo nakonfigurovalo.

Návraty

Typ spuštění.

Návratový typ

str