Run Osztály
Meghatározza az összes Azure Machine Learning-kísérletfuttatás alaposztályát.
A futtatás egy kísérlet egyetlen próbaverzióját jelenti. A futtatások a próbaverzió aszinkron végrehajtásának monitorozására, a naplómetrikák és a próbaverzió kimenetének tárolására, valamint a próbaverzió által létrehozott eredmények és összetevők elérésének elemzésére szolgálnak.
A futtatási objektumok akkor jönnek létre, amikor egy szkriptet küld be egy modell betanítása érdekében az Azure Machine Learning számos különböző forgatókönyvében, beleértve a HyperDrive-futtatásokat, a folyamatfuttatásokat és az AutoML-futtatásokat. A Run objektum akkor is létrejön, ha Ön submit vagy start_logging az Experiment osztály mellett van.
A kísérletek és a futtatások első lépéseit lásd:
Inicializálja a Run objektumot.
- Öröklődés
-
azureml._run_impl.run_base._RunBaseRun
Konstruktor
Run(experiment, run_id, outputs=None, **kwargs)Paraméterek
| Name | Description |
|---|---|
|
experiment
Kötelező
|
A tartalmú kísérlet. |
|
run_id
Kötelező
|
A futtatás azonosítója. |
|
outputs
|
A nyomon követendő kimenetek. Alapértelmezett érték: None
|
|
_run_dto
Kötelező
|
<xref:azureml._restclient.models.run_dto.RunDto>
Csak belső használatra. |
|
kwargs
Kötelező
|
További konfigurációs paraméterek szótára. |
|
experiment
Kötelező
|
A tartalmú kísérlet. |
|
run_id
Kötelező
|
A futtatás azonosítója. |
|
outputs
Kötelező
|
A nyomon követendő kimenetek. |
|
kwargs
Kötelező
|
További konfigurációs paraméterek szótára. |
Megjegyzések
A futtatás egy kísérlet egyetlen próbaverzióját jelenti. A Run objektum a próbaverzió aszinkron végrehajtásának figyelésére, a naplómetrikák és a próbaverzió kimenetének tárolására, valamint a próbaverzió által generált eredmények és a hozzáférési összetevők elemzésére szolgál.
A futtatás a kísérletezés kódjában használható metrikák és összetevők naplózására a Futtatási előzmények szolgáltatásban.
A futtatás a kísérleteken kívül a folyamat figyelésére, valamint a létrehozott metrikák és eredmények lekérdezésére és elemzésére szolgál.
A Futtatás funkció a következőket tartalmazza:
Metrikák és adatok tárolása és lekérése
Fájlok feltöltése és letöltése
Címkék és gyermekhierarchiák használata a korábbi futtatások egyszerű kereséséhez
Tárolt modellfájlok regisztrálása üzembe helyezhető modellként
Futtatás tulajdonságainak tárolása, módosítása és lekérése
Az aktuális futtatás betöltése távoli környezetből a get_context metódussal
Fájl vagy könyvtár hatékony pillanatképezése a reprodukálhatóság érdekében
Ez az osztály az Experiment alábbi forgatókönyvekkel működik együtt:
Futtatás létrehozása kód végrehajtásával a használatával submit
Futtatás interaktív létrehozása jegyzetfüzetben a használatával start_logging
Metrikák naplózása és összetevők feltöltése a kísérletbe, például a log
Metrikák olvasása és összetevők letöltése kísérleti eredmények elemzésekor, például a get_metrics
Futtatás elküldéséhez hozzon létre egy konfigurációs objektumot, amely leírja a kísérlet futtatásának módját. Íme néhány példa a különböző konfigurációs objektumokra, amelyeket használhat:
azureml.train.automl.automlconfig.AutoMLConfig
azureml.train.hyperdrive.HyperDriveConfig
azureml.pipeline.core.Pipeline
azureml.pipeline.core.PublishedPipeline
azureml.pipeline.core.PipelineEndpoint
A kísérlet betanítása során a következő metrikák vehetők fel a futtatásba.
Skalár
Naplózhat egy numerikus vagy sztringértéket a futtatásba a megadott névvel a használatával log. Ha egy metrikát futtatásra naplóz, az azt eredményezi, hogy a metrika a kísérletben a futtatási rekordban lesz tárolva. Ugyanazt a metrikát többször is naplózhatja egy futtatáson belül, az eredményt a metrika vektorának tekinti.
Például:
run.log("accuracy", 0.95)
Lista
Naplózza az értékek listáját a futtatásba a megadott névvel a használatával log_list.
Például:
run.log_list("accuracies", [0.6, 0.7, 0.87])
Sor
A használatával log_row létrehoz egy metrikát, amely több oszlopot tartalmaz a(z) szakaszban
kwargsleírtak szerint. Minden megnevezett paraméter létrehoz egy oszlopot a megadott értékkel.log_rowegyszer hívható meg egy tetszőleges rekord naplózásához, vagy egy ciklusban többször is egy teljes tábla létrehozásához.Például:
run.log_row("Y over X", x=1, y=0.4)
Tábla
A paranccsal naplózhat egy szótárobjektumot a futtatásba a megadott névvel log_table.
Például:
run.log_table("Y over X", {"x":[1, 2, 3], "y":[0.6, 0.7, 0.89]})
Kép
Lemezkép naplózása a futtatási rekordba. A használatával log_image naplózhat egy képfájlt vagy egy matplotlib-diagramot a futtatásra. Ezek a képek a futtatási rekordban láthatók és összehasonlíthatók lesznek.
Például:
run.log_image("ROC", path)
Metódusok
| add_properties |
Adjon hozzá nem módosítható tulajdonságokat a futtatáshoz. A címkék és a tulajdonságok (mind a dict[str, str]) eltérőek a módosíthatóságukban. A tulajdonságok nem módosíthatók, ezért naplózási célból állandó rekordot hoznak létre. A címkék nem módosíthatók. A címkék és tulajdonságok használatával kapcsolatos további információkért lásd: Címkék és futtatások keresése. |
| add_type_provider |
Bővíthetőségi horog a futtatási előzményekben tárolt egyéni futtatási típusokhoz. |
| cancel |
A futtatás megjelölése megszakítottként. Ha van egy társított feladat egy beállított cancel_uri mezővel, állítsa le a feladatot is. |
| child_run |
Hozzon létre egy gyermekfuttatást. |
| clean |
Távolítsa el az aktuális futtatásnak megfelelő fájlokat a futtatási konfigurációban megadott célon. |
| complete |
Várjon, amíg a feladatsor feldolgozásra kerül. Ezután a futtatás befejezettként lesz megjelölve. Ezt általában interaktív jegyzetfüzet-forgatókönyvekben használják. |
| create_children |
Hozzon létre egy vagy több gyermekfuttatást. |
| download_file |
Töltse le a társított fájlt a tárolóból. |
| download_files |
Ha az előtag nincs meghatározva, töltsön le fájlokat egy adott tárolási előtagból (mappanévből) vagy a teljes tárolóból. |
| fail |
A futtatás megjelölése sikertelenként. Ha szeretné, állítsa be a futtatás Error tulajdonságát egy üzenettel vagy kivétellel, amely a következőnek lett átadva |
| flush |
Várjon, amíg a feladatsor feldolgozásra kerül. |
| get |
Kérje le a munkaterület futtatási azonosítóját. |
| get_all_logs |
Töltse le a futtatás összes naplóját egy könyvtárba. |
| get_children |
Az aktuális futtatás összes gyermekének lekérése megadott szűrőkkel kiválasztva. |
| get_context |
Az aktuális szolgáltatáskörnyezetet adja vissza. Ezzel a módszerrel lekérheti a metrikák naplózásához és a fájlok feltöltéséhez használt aktuális szolgáltatáskörnyezetet. Ha |
| get_detailed_status |
Kérje le a futtatás legújabb állapotát. Ha a futtatás állapota "Várólistán", akkor a részletek megjelennek. |
| get_details |
Kérje le a definíciót, az állapotinformációkat, az aktuális naplófájlokat és a futtatás egyéb részleteit. |
| get_details_with_logs |
A futtatás állapotának visszaküldése a naplófájl tartalmával együtt. |
| get_environment |
Kérje le a futtatás által használt környezeti definíciót. |
| get_file_names |
Listázhatja a futtatással társítva tárolt fájlokat. |
| get_metrics |
Kérje le a futtatásra naplózott metrikákat. Ha |
| get_properties |
Kérje le a futtatás legújabb tulajdonságait a szolgáltatásból. |
| get_secret |
A titkos kód értékének lekérése a futtatás környezetéből. Kérje le a megadott név titkos értékét. A titkos kód neve egy, a munkaterülethez társított Azure-Key Vault tárolt értékre hivatkozik. A titkos kódok használatáról a Titkos kódok használata betanítási futtatásokban című témakörben talál példát. |
| get_secrets |
Lekérheti a titkos nevek adott listájának titkos értékeit. A megadott nevek listájához szerezze be a talált és a nem talált titkos kulcsok szótárát. Minden titkos kódnév egy, a munkaterülethez társított Azure-Key Vault tárolt értékre hivatkozik. A titkos kódok használatáról a Titkos kódok használata betanítási futtatásokban című témakörben talál példát. |
| get_snapshot_id |
Szerezze be a legújabb pillanatkép-azonosítót. |
| get_status |
A futtatás legújabb állapotának lekérése. A visszaadott gyakori értékek közé tartozik a "Futtatás", a "Kész" és a "Sikertelen". |
| get_submitted_run |
ELAVULT. Használja az get_context parancsot. A kísérlethez beküldött futtatás lekérése. |
| get_tags |
Lekérje a futtatás során a legújabb mutable-címkéket a szolgáltatásból. |
| list |
Lekérheti az opcionális szűrők által megadott kísérlet futtatási listáját. |
| list_by_compute |
Lekérheti az opcionális szűrők által megadott számításban futtatott futtatások listáját. |
| log |
Naplózhat egy metrikaértéket a futtatásban a megadott névvel. |
| log_accuracy_table |
Naplózza a pontossági táblát az összetevőtárolóba. A pontossági tábla metrika egy többszörös használatú, nem skaláris metrika, amely több típusú vonaldiagram előállítására használható, amelyek folyamatosan változnak az előrejelzett valószínűségek területén. Ilyen diagramok például a ROC, a pontosság-visszahívás és az emelési görbék. A pontossági tábla számítása hasonló az ROC-görbe kiszámításához. A ROC-görbék a valós pozitív arányokat és a hamis pozitív arányokat számos különböző valószínűségi küszöbértéken tárolják. A pontossági táblázat a valós pozitívok, a hamis pozitívok, a valódi negatívok és a hamis negatívok nyers számát tárolja számos valószínűségi küszöbértéken. A küszöbértékek kiválasztásához két módszer használható: "valószínűség" és "percentilis". Különböznek az előrejelzett valószínűségek térbeli mintavételi módjától. A valószínűségi küszöbértékek 0 és 1 közötti, egyenletesen elosztott küszöbértékek. Ha NUM_POINTS 5, a valószínűségi küszöbértékek [0,0, 0,25, 0,5, 0,75, 1,0]. A percentilis küszöbértékek az előrejelzett valószínűségek eloszlása szerint vannak elosztva. Az egyes küszöbértékek az adatok valószínűségi küszöbértékben megadott percentilisének felelnek meg. Ha például NUM_POINTS 5, akkor az első küszöbérték a 0. percentilis, a második a 25. percentilis, a harmadik az 50. A valószínűségi táblázatok és a percentilistáblák egyaránt 3D listák, ahol az első dimenzió az osztálycímkét jelöli, a második dimenzió a mintát egy küszöbnél jelöli (skálázás NUM_POINTS), a harmadik dimenzió pedig mindig 4 értékkel rendelkezik: TP, FP, TN, FN és mindig ebben a sorrendben. A keveredési értékek (TP, FP, TN, FN) az egy és a rest stratégiával vannak kiszámítva. További részletekért tekintse meg az alábbi hivatkozást: https://en.wikipedia.org/wiki/Multiclass_classification N = az érvényesítési adathalmazban lévő minták száma (200 példa) M = # küszöbértékek = # a valószínűségi térből vett minták (például 5) C = # osztályok a teljes adathalmazban (3 a példában) A pontossági táblázat néhány invariánsa:
Megjegyzés: M bármilyen érték lehet, és szabályozza a diagramok felbontását Ez független az adathalmaztól, a metrikák kiszámításakor van meghatározva, és a tárterületet, a számítási időt és a felbontást cseréli le. Az osztályfeliratoknak sztringeknek, a keveredési értékeknek egész számoknak, a küszöbértékeknek pedig lebegőpontosnak kell lenniük. |
| log_confusion_matrix |
Kavarodási mátrix naplózása az összetevőtárolóba. Ez naplóz egy burkolót a sklearn keveredési mátrix körül. A metrikaadatok tartalmazzák az osztályfeliratokat és magának a mátrixnak a 2D-listáját. A metrikák kiszámításának módjával kapcsolatos további részletekért tekintse meg az alábbi hivatkozást: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html |
| log_image |
Naplózza a rendszerképmetrikát a futtatási rekordba. |
| log_list |
Naplózza a metrikaértékek listáját a futtatásba a megadott névvel. |
| log_predictions |
Napló-előrejelzések az összetevőtárolóba. Ez naplóz egy metrikapontszámot, amely a valódi célértékek eloszlásának összehasonlítására használható a regressziós tevékenység előrejelzett értékeinek eloszlásával. Az előrejelzések rögzítve vannak, és a program kiszámítja a szórásokat a vonaldiagram hibasávjaihoz. |
| log_residuals |
Naplózhatja a reziduálisokat az összetevőtárolóba. Ez naplózza a regressziós feladat reziduálisainak hisztogramjának megjelenítéséhez szükséges adatokat. A reziduálisok előrejelzése – tényleges. A darabszámnál egynél több élnek kell lennie. Tekintse meg a numpy hisztogram dokumentációját, amely példákat tartalmaz a hisztogramok számának és éleinek ábrázolására. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html |
| log_row |
Naplózhat egy sormetrikát a futtatásba a megadott névvel. |
| log_table |
Naplózhat egy táblametrikát a futtatásba a megadott névvel. |
| register_model |
Modell regisztrálása az üzembe helyezéshez. |
| remove_tags |
Törölje a futtatáskor a táblacímkék listáját. |
| restore_snapshot |
Pillanatkép visszaállítása ZIP-fájlként. A ZIP elérési útját adja vissza. |
| set_tags |
Adjon hozzá vagy módosítson egy címkekészletet a futtatáskor. A szótárban nem átadott címkék érintetlenek maradnak. Egyszerű sztringcímkéket is hozzáadhat. Ha ezek a címkék kulcsokként jelennek meg a címkeszótárban, akkor a Nincs értékkel rendelkeznek. További információ: Futtatások címkézése és keresése. |
| start |
A futtatás megjelölése indításként. Ezt általában speciális forgatókönyvekben használják, ha a futtatást egy másik szereplő hozta létre. |
| submit_child |
Küldjön be egy kísérletet, és adja vissza az aktív gyermekfuttatást. |
| tag |
A futtatás címkézése sztringkulccsal és opcionális sztringértékkel. |
| take_snapshot |
Mentse a bemeneti fájl vagy mappa pillanatképét. |
| upload_file |
Töltsön fel egy fájlt a futtatási rekordba. |
| upload_files |
Fájlok feltöltése a futtatási rekordba. |
| upload_folder |
Töltse fel a megadott mappát a megadott előtag nevére. |
| wait_for_completion |
Várja meg a futtatás befejezését. A várakozás után visszaadja az állapotobjektumot. |
add_properties
Adjon hozzá nem módosítható tulajdonságokat a futtatáshoz.
A címkék és a tulajdonságok (mind a dict[str, str]) eltérőek a módosíthatóságukban. A tulajdonságok nem módosíthatók, ezért naplózási célból állandó rekordot hoznak létre. A címkék nem módosíthatók. A címkék és tulajdonságok használatával kapcsolatos további információkért lásd: Címkék és futtatások keresése.
add_properties(properties)Paraméterek
| Name | Description |
|---|---|
|
properties
Kötelező
|
A futtatási objektumban tárolt rejtett tulajdonságok. |
add_type_provider
Bővíthetőségi horog a futtatási előzményekben tárolt egyéni futtatási típusokhoz.
static add_type_provider(runtype, run_factory)Paraméterek
| Name | Description |
|---|---|
|
runtype
Kötelező
|
Annak a Run.type értéknek a értéke, amelyhez a gyárat meghívja a rendszer. Ilyen például a "hyperdrive" vagy az "azureml.scriptrun", de egyéni típusokkal bővíthető. |
|
run_factory
Kötelező
|
<xref:function>
Aláírással (Experiment, RunDto) rendelkező függvény –> Futtatás a futtatások listázásakor meghívható. |
cancel
A futtatás megjelölése megszakítottként.
Ha van egy társított feladat egy beállított cancel_uri mezővel, állítsa le a feladatot is.
cancel()child_run
Hozzon létre egy gyermekfuttatást.
child_run(name=None, run_id=None, outputs=None)Paraméterek
| Name | Description |
|---|---|
|
name
|
A gyermekfuttatás nem kötelező neve, amely általában egy "részhez" van megadva. Alapértelmezett érték: None
|
|
run_id
|
A gyermek opcionális futtatási azonosítója, ellenkező esetben automatikusan létre lesz hozva. Ez a paraméter általában nincs beállítva. Alapértelmezett érték: None
|
|
outputs
|
Nem kötelező kimenetek könyvtára a gyermek nyomon követéséhez. Alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
A gyermek fut. |
Megjegyzések
Ez egy részszakaszba történő futtatás egy részének elkülönítésére szolgál. Ez egy futtatás azonosítható "részei" esetében is elvégezhető, amelyek érdekesek a szétválasztáshoz, vagy a független metrikák rögzítéséhez egy alfolyamat interatinálásához.
Ha a gyermekfuttatáshoz kimeneti könyvtár van beállítva, a rendszer a gyermek befejezésekor feltölti a gyermekfuttatási rekordba a könyvtár tartalmát.
clean
Távolítsa el az aktuális futtatásnak megfelelő fájlokat a futtatási konfigurációban megadott célon.
clean()Válaszok
| Típus | Description |
|---|---|
|
A törölt fájlok listája. |
complete
Várjon, amíg a feladatsor feldolgozásra kerül.
Ezután a futtatás befejezettként lesz megjelölve. Ezt általában interaktív jegyzetfüzet-forgatókönyvekben használják.
complete(_set_status=True)Paraméterek
| Name | Description |
|---|---|
|
_set_status
|
Azt jelzi, hogy elküldje-e az állapoteseményt nyomon követés céljából. Alapértelmezett érték: True
|
create_children
Hozzon létre egy vagy több gyermekfuttatást.
create_children(count=None, tag_key=None, tag_values=None)Paraméterek
| Name | Description |
|---|---|
|
count
|
Tetszőleges számú gyermek létrehozása. Alapértelmezett érték: None
|
|
tag_key
|
Választható kulcs a Címkék bejegyzés feltöltéséhez az összes létrehozott gyermekben. Alapértelmezett érték: None
|
|
tag_Values
Kötelező
|
A létrehozott futtatások listájához tartozó Címkék[tag_key] értékeket tartalmazó választható lista. |
|
tag_values
|
Alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
A gyermekfuttatások listája. |
Megjegyzések
Vagy paramétert count vagy paramétert tag_valuestag_key és paramétert kell megadni.
download_file
Töltse le a társított fájlt a tárolóból.
download_file(name, output_file_path=None, _validate_checksum=False)Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A letölteni kívánt összetevő neve. |
|
output_file_path
Kötelező
|
A helyi elérési út, ahol az összetevőt tárolni kell. |
download_files
Ha az előtag nincs meghatározva, töltsön le fájlokat egy adott tárolási előtagból (mappanévből) vagy a teljes tárolóból.
download_files(prefix=None, output_directory=None, output_paths=None, batch_size=100, append_prefix=True, timeout_seconds=None)Paraméterek
| Name | Description |
|---|---|
|
prefix
Kötelező
|
A tárolón belüli filepath előtag, amelyről az összes összetevőt le szeretné tölteni. |
|
output_directory
Kötelező
|
Nem kötelező könyvtár, amelyet az összes összetevő elérési útja előtagként használ. |
|
output_paths
Kötelező
|
[str]
Nem kötelező fájlútvonal, amelyben a letöltött összetevőket tárolni szeretné. Egyedinek kell lennie, és meg kell egyeznie az elérési utak hosszával. |
|
batch_size
Kötelező
|
A kötegenként letöltendő fájlok száma. Az alapértelmezett érték 100 fájl. |
|
append_prefix
Kötelező
|
Választható jelző, hogy hozzá kívánja-e fűzni a megadott előtagot a végső kimeneti fájl elérési útjából. Ha Hamis, akkor az előtag el lesz távolítva a kimeneti fájl elérési útjából. |
|
timeout_seconds
Kötelező
|
A fájlok letöltésének időtúllépése. |
fail
A futtatás megjelölése sikertelenként.
Ha szeretné, állítsa be a futtatás Error tulajdonságát egy üzenettel vagy kivétellel, amely a következőnek lett átadva error_details: .
fail(error_details=None, error_code=None, _set_status=True)Paraméterek
| Name | Description |
|---|---|
|
error_details
|
str vagy
BaseException
A hiba nem kötelező részletei. Alapértelmezett érték: None
|
|
error_code
|
A hibabesorolás hibakódja nem kötelező. Alapértelmezett érték: None
|
|
_set_status
|
Azt jelzi, hogy elküldi-e az állapoteseményt nyomon követés céljából. Alapértelmezett érték: True
|
flush
Várjon, amíg a feladatsor feldolgozásra kerül.
flush(timeout_seconds=300)Paraméterek
| Name | Description |
|---|---|
|
timeout_seconds
|
Mennyi ideig kell várni (másodpercben) a feladatsor feldolgozására. Alapértelmezett érték: 300
|
get
Kérje le a munkaterület futtatási azonosítóját.
static get(workspace, run_id)Paraméterek
| Name | Description |
|---|---|
|
workspace
Kötelező
|
Az azt tartalmazó munkaterület. |
|
run_id
Kötelező
|
A futtatási azonosító. |
Válaszok
| Típus | Description |
|---|---|
|
A beküldött futtatás. |
get_all_logs
Töltse le a futtatás összes naplóját egy könyvtárba.
get_all_logs(destination=None)Paraméterek
| Name | Description |
|---|---|
|
destination
|
A naplók tárolásának célútvonala. Ha nincs meghatározva, a projektkönyvtárban létrejön egy futtatási azonosítóként elnevezett könyvtár. Alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
A letöltött naplók nevének listája. |
get_children
Az aktuális futtatás összes gyermekének lekérése megadott szűrőkkel kiválasztva.
get_children(recursive=False, tags=None, properties=None, type=None, status=None, _rehydrate_runs=True)Paraméterek
| Name | Description |
|---|---|
|
recursive
|
Azt jelzi, hogy az összes leszármazotton keresztül ismétlődjön-e. Alapértelmezett érték: False
|
|
tags
|
Ha meg van adva, a megadott "címke" vagy {"tag": "value"} egyező futtatásokat ad vissza. Alapértelmezett érték: None
|
|
properties
|
Ha meg van adva, a visszaadott függvény a megadott "tulajdonság" vagy {"property": "value"}. Alapértelmezett érték: None
|
|
type
|
Ha meg van adva, az ilyen típusú futtatásokat adja vissza. Alapértelmezett érték: None
|
|
status
|
Ha meg van adva, a megadott állapotú futtatásokat adja vissza. Alapértelmezett érték: None
|
|
_rehydrate_runs
|
Azt jelzi, hogy az eredeti típusú futtatás vagy az alapfuttatás példányosítására van-e lehetőség. Alapértelmezett érték: True
|
Válaszok
| Típus | Description |
|---|---|
|
Objektumok listája Run . |
get_context
Az aktuális szolgáltatáskörnyezetet adja vissza.
Ezzel a módszerrel lekérheti a metrikák naplózásához és a fájlok feltöltéséhez használt aktuális szolgáltatáskörnyezetet. Ha allow_offline igaz (ez az alapértelmezett érték), a Run objektumon végzett műveletek normál állapotban lesznek kinyomtatva.
get_context(allow_offline=True, used_for_context_manager=False, **kwargs)Paraméterek
| Name | Description |
|---|---|
|
cls
Kötelező
|
Osztálymetódust jelez. |
|
allow_offline
|
Engedélyezze, hogy a szolgáltatáskörnyezet visszaálljon offline módba, hogy a betanítási szkript helyileg tesztelhető legyen anélkül, hogy feladatot kellene küldenie az SDK-val. Alapértelmezés szerint igaz. Alapértelmezett érték: True
|
|
kwargs
Kötelező
|
További paraméterek szótára. |
|
used_for_context_manager
|
Alapértelmezett érték: False
|
Válaszok
| Típus | Description |
|---|---|
|
A beküldött futtatás. |
Megjegyzések
Ezt a függvényt gyakran használják a hitelesített Run objektum lekérésére egy szkripten belül, amelyet az experiment.submit() használatával kell végrehajtásra elküldeni. Ez a futtatási objektum egy hitelesített környezet az Azure Machine Learning-szolgáltatásokkal való kommunikációhoz, valamint egy fogalmi tároló, amelyben metrikák, fájlok (összetevők) és modellek találhatók.
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
Kérje le a futtatás legújabb állapotát. Ha a futtatás állapota "Várólistán", akkor a részletek megjelennek.
get_detailed_status()Válaszok
| Típus | Description |
|---|---|
|
A legújabb állapot és részletek |
Megjegyzések
status: A futtatás aktuális állapota. Ugyanaz az érték, mint a get_status()-ből visszaadott érték.
részletek: Az aktuális állapot részletes információi.
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
Kérje le a definíciót, az állapotinformációkat, az aktuális naplófájlokat és a futtatás egyéb részleteit.
get_details()Válaszok
| Típus | Description |
|---|---|
|
A futtatás részleteinek visszaadása |
Megjegyzések
A visszaadott szótár a következő kulcs-érték párokat tartalmazza:
runId: A futtatás azonosítója.
Cél
status: A futtatás aktuális állapota. Ugyanaz az érték, mint a get_status()-ből visszaadott érték.
startTimeUtc: A futtatás indításának UTC időpontja az ISO8601-ben.
endTimeUtc: A futtatás (befejezett vagy sikertelen) ISO8601-ben való befejezésének (UTC) időpontja.
Ez a kulcs nem létezik, ha a futtatás még folyamatban van.
properties: A futtatáshoz társított nem módosítható kulcs-érték párok. Az alapértelmezett tulajdonságok közé tartozik a futtatás pillanatkép-azonosítója és a futtatás alapjául szolgáló Git-adattár adatai (ha vannak ilyenek). A paranccsal add_propertiestovábbi tulajdonságokat adhat hozzá a futtatáshoz.
inputDatasets: A futtatáshoz társított bemeneti adatkészletek.
outputDatasets: A futtatáshoz társított kimeneti adatkészletek.
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
A futtatás állapotának visszaküldése a naplófájl tartalmával együtt.
get_details_with_logs()Válaszok
| Típus | Description |
|---|---|
|
A futtatás állapotát adja vissza a naplófájl tartalmával. |
get_environment
Kérje le a futtatás által használt környezeti definíciót.
get_environment()Válaszok
| Típus | Description |
|---|---|
|
Adja vissza a környezeti objektumot. |
get_file_names
Listázhatja a futtatással társítva tárolt fájlokat.
get_file_names()Válaszok
| Típus | Description |
|---|---|
|
A meglévő összetevők elérési útjainak listája |
get_metrics
Kérje le a futtatásra naplózott metrikákat.
Ha recursive igaz (alapértelmezés szerint hamis), akkor kérje le az adott futtatás altartományában lévő futtatások metrikáit.
get_metrics(name=None, recursive=False, run_type=None, populate=False)Paraméterek
| Name | Description |
|---|---|
|
name
|
A metrika neve. Alapértelmezett érték: None
|
|
recursive
|
Azt jelzi, hogy az összes leszármazotton keresztül ismétlődjön-e. Alapértelmezett érték: False
|
|
run_type
|
Alapértelmezett érték: None
|
|
populate
|
Azt jelzi, hogy beolvassa-e a metrikához csatolt külső adatok tartalmát. Alapértelmezett érték: False
|
Válaszok
| Típus | Description |
|---|---|
|
A felhasználói metrikákat tartalmazó szótár. |
Megjegyzések
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
Kérje le a futtatás legújabb tulajdonságait a szolgáltatásból.
get_properties()Válaszok
| Típus | Description |
|---|---|
|
A futtatás tulajdonságai. |
Megjegyzések
A tulajdonságok nem módosítható rendszer által létrehozott információk, például az időtartam, a végrehajtás dátuma, a felhasználó és a add_properties metódussal hozzáadott egyéni tulajdonságok. További információ: Futtatások címkézése és keresése.
Amikor feladatot küld az Azure Machine Learningnek, ha a forrásfájlokat egy helyi Git-adattár tárolja, akkor az adattár adatai tulajdonságokként lesznek tárolva. Ezek a git-tulajdonságok a futtatás vagy az Experiment.submit hívása során lesznek hozzáadva. A git tulajdonságaival kapcsolatos további információkért lásd: Git-integráció az Azure Machine Learninghez.
get_secret
A titkos kód értékének lekérése a futtatás környezetéből.
Kérje le a megadott név titkos értékét. A titkos kód neve egy, a munkaterülethez társított Azure-Key Vault tárolt értékre hivatkozik. A titkos kódok használatáról a Titkos kódok használata betanítási futtatásokban című témakörben talál példát.
get_secret(name)Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A titkos kód neve, amelynek titkos kódját vissza szeretné adni. |
Válaszok
| Típus | Description |
|---|---|
|
A titkos kód értéke. |
get_secrets
Lekérheti a titkos nevek adott listájának titkos értékeit.
A megadott nevek listájához szerezze be a talált és a nem talált titkos kulcsok szótárát. Minden titkos kódnév egy, a munkaterülethez társított Azure-Key Vault tárolt értékre hivatkozik. A titkos kódok használatáról a Titkos kódok használata betanítási futtatásokban című témakörben talál példát.
get_secrets(secrets)Paraméterek
| Name | Description |
|---|---|
|
secrets
Kötelező
|
Azoknak a titkos kódoknak a listája, amelyeknek titkos értékeket kell visszaadnia. |
Válaszok
| Típus | Description |
|---|---|
|
A talált és a nem talált titkos kódok szótárát adja vissza. |
get_snapshot_id
Szerezze be a legújabb pillanatkép-azonosítót.
get_snapshot_id()Válaszok
| Típus | Description |
|---|---|
|
A legújabb pillanatkép-azonosító. |
get_status
A futtatás legújabb állapotának lekérése.
A visszaadott gyakori értékek közé tartozik a "Futtatás", a "Kész" és a "Sikertelen".
get_status()Válaszok
| Típus | Description |
|---|---|
|
A legújabb állapot. |
Megjegyzések
NotStarted – Ez egy ideiglenes állapotú ügyféloldali Run objektum, amely a felhőbeküldés előtt található.
Indítás – A futtatás megkezdődött a felhőben való feldolgozásban. A hívó ezen a ponton futtatási azonosítóval rendelkezik.
Kiépítés – Akkor adja vissza, ha igény szerinti számítást hoz létre egy adott feladatbeküldéshez.
Előkészítés – A futtatási környezet előkészítése folyamatban van:
docker-rendszerkép buildelése
conda-környezet beállítása
Queued – A feladat várólistára kerül a számítási célban. A BatchAI-ban például a feladat várólistán van
amíg az összes kért csomópont készen áll.
Futtatás – A feladat a számítási célban kezdett futni.
Véglegesítés – A felhasználói kód befejeződött, és a futtatás a feldolgozás utáni fázisban van.
CancelRequested – A feladat lemondását kérték.
Befejezve – A futtatás sikeresen befejeződött. Ez magában foglalja a felhasználói kódot és a futtatás
utófeldolgozási fázisok.
Sikertelen – A futtatás sikertelen volt. Általában a Futtatás hiba tulajdonsága adja meg a részleteket, hogy miért.
Megszakítva – Egy lemondási kérést követ, és azt jelzi, hogy a futtatás sikeresen megszakadt.
NotKiszolgáló – Azon futtatások esetében, amelyeken engedélyezve van a szívverés, a rendszer nem küldött szívverést a közelmúltban.
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
ELAVULT. Használja az get_context parancsot.
A kísérlethez beküldött futtatás lekérése.
get_submitted_run(**kwargs)Válaszok
| Típus | Description |
|---|---|
|
A beküldött futtatás. |
get_tags
Lekérje a futtatás során a legújabb mutable-címkéket a szolgáltatásból.
get_tags()Válaszok
| Típus | Description |
|---|---|
|
A futtatási objektumon tárolt címkék. |
list
Lekérheti az opcionális szűrők által megadott kísérlet futtatási listáját.
static list(experiment, type=None, tags=None, properties=None, status=None, include_children=False, _rehydrate_runs=True)Paraméterek
| Name | Description |
|---|---|
|
experiment
Kötelező
|
A tartalmú kísérlet. |
|
type
|
Ha meg van adva, a megadott típusnak megfelelő futtatásokat ad vissza. Alapértelmezett érték: None
|
|
tags
|
Ha meg van adva, a megadott "címke" vagy {"tag": "value"} futtatását adja vissza. Alapértelmezett érték: None
|
|
properties
|
Ha meg van adva, a megadott "tulajdonság" vagy {"tulajdonság": "value"} futtatását adja vissza. Alapértelmezett érték: None
|
|
status
|
Ha meg van adva, a megadott állapotú futtatásokat adja vissza. Alapértelmezett érték: None
|
|
include_children
|
Ha igaz értékre van állítva, az összes futtatás lekérése, nem csak a legfelső szintűek. Alapértelmezett érték: False
|
|
_rehydrate_runs
|
Ha igaz (alapértelmezés szerint) értékre van állítva, a regisztrált szolgáltatóval az alapfuttatás helyett az adott típushoz tartozó objektumot állítja be újra. Alapértelmezett érték: True
|
Válaszok
| Típus | Description |
|---|---|
|
Futtatások listája. |
Megjegyzések
Az alábbi példakód a list metódus néhány használatát mutatja be.
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
Lekérheti az opcionális szűrők által megadott számításban futtatott futtatások listáját.
static list_by_compute(compute, type=None, tags=None, properties=None, status=None)Paraméterek
| Name | Description |
|---|---|
|
compute
Kötelező
|
A számítást tartalmazó. |
|
type
|
Ha meg van adva, a megadott típusnak megfelelő futtatásokat ad vissza. Alapértelmezett érték: None
|
|
tags
|
Ha meg van adva, a megadott "címke" vagy {"tag": "value"} futtatását adja vissza. Alapértelmezett érték: None
|
|
properties
|
Ha meg van adva, a megadott "tulajdonság" vagy {"tulajdonság": "value"} futtatását adja vissza. Alapértelmezett érték: None
|
|
status
|
Ha meg van adva, a megadott állapotú futtatásokat adja vissza. Csak a "Futtatás" és a "Queued" engedélyezett értékek engedélyezettek. Alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
<xref:builtin.generator>
|
a ~_restclient.models.RunDto generátora |
log
Naplózhat egy metrikaértéket a futtatásban a megadott névvel.
log(name, value, description='', step=None)Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A metrika neve. |
|
value
Kötelező
|
A szolgáltatásban közzéteendő érték. |
|
description
Kötelező
|
Választható metrikaleírás. |
|
step
|
Nem kötelező tengely egy metrika értékrendének megadásához. Alapértelmezett érték: None
|
Megjegyzések
Ha egy metrikát futtatásra naplóz, az azt eredményezi, hogy a metrika a kísérletben a futtatási rekordban lesz tárolva. Ugyanazt a metrikát többször is naplózhatja egy futtatáson belül, az eredményt a metrika vektorának tekinti. Ha egy metrika esetében a lépés meg van adva, azt minden értékhez meg kell adni.
log_accuracy_table
Naplózza a pontossági táblát az összetevőtárolóba.
A pontossági tábla metrika egy többszörös használatú, nem skaláris metrika, amely több típusú vonaldiagram előállítására használható, amelyek folyamatosan változnak az előrejelzett valószínűségek területén. Ilyen diagramok például a ROC, a pontosság-visszahívás és az emelési görbék.
A pontossági tábla számítása hasonló az ROC-görbe kiszámításához. A ROC-görbék a valós pozitív arányokat és a hamis pozitív arányokat számos különböző valószínűségi küszöbértéken tárolják. A pontossági táblázat a valós pozitívok, a hamis pozitívok, a valódi negatívok és a hamis negatívok nyers számát tárolja számos valószínűségi küszöbértéken.
A küszöbértékek kiválasztásához két módszer használható: "valószínűség" és "percentilis". Különböznek az előrejelzett valószínűségek térbeli mintavételi módjától.
A valószínűségi küszöbértékek 0 és 1 közötti, egyenletesen elosztott küszöbértékek. Ha NUM_POINTS 5, a valószínűségi küszöbértékek [0,0, 0,25, 0,5, 0,75, 1,0].
A percentilis küszöbértékek az előrejelzett valószínűségek eloszlása szerint vannak elosztva. Az egyes küszöbértékek az adatok valószínűségi küszöbértékben megadott percentilisének felelnek meg. Ha például NUM_POINTS 5, akkor az első küszöbérték a 0. percentilis, a második a 25. percentilis, a harmadik az 50.
A valószínűségi táblázatok és a percentilistáblák egyaránt 3D listák, ahol az első dimenzió az osztálycímkét jelöli, a második dimenzió a mintát egy küszöbnél jelöli (skálázás NUM_POINTS), a harmadik dimenzió pedig mindig 4 értékkel rendelkezik: TP, FP, TN, FN és mindig ebben a sorrendben.
A keveredési értékek (TP, FP, TN, FN) az egy és a rest stratégiával vannak kiszámítva. További részletekért tekintse meg az alábbi hivatkozást: https://en.wikipedia.org/wiki/Multiclass_classification
N = az érvényesítési adathalmazban lévő minták száma (200 példa) M = # küszöbértékek = # a valószínűségi térből vett minták (például 5) C = # osztályok a teljes adathalmazban (3 a példában)
A pontossági táblázat néhány invariánsa:
- TP + FP + TN + FN = N az összes osztály összes küszöbértékéhez
- A TP + FN minden osztály küszöbértéke megegyezik
- A TN + FP minden osztály küszöbértéke megegyezik
- A valószínűségtáblák és a percentilistáblák alakzata [C, M, 4]
Megjegyzés: M bármilyen érték lehet, és szabályozza a diagramok felbontását Ez független az adathalmaztól, a metrikák kiszámításakor van meghatározva, és a tárterületet, a számítási időt és a felbontást cseréli le.
Az osztályfeliratoknak sztringeknek, a keveredési értékeknek egész számoknak, a küszöbértékeknek pedig lebegőpontosnak kell lenniük.
log_accuracy_table(name, value, description='')Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A pontossági tábla neve. |
|
value
Kötelező
|
Név- és verzió- és adattulajdonságokat tartalmazó JSON. |
|
description
Kötelező
|
Választható metrikaleírás. |
Megjegyzések
Példa érvényes JSON-értékre:
{
"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
Kavarodási mátrix naplózása az összetevőtárolóba.
Ez naplóz egy burkolót a sklearn keveredési mátrix körül. A metrikaadatok tartalmazzák az osztályfeliratokat és magának a mátrixnak a 2D-listáját. A metrikák kiszámításának módjával kapcsolatos további részletekért tekintse meg az alábbi hivatkozást: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html
log_confusion_matrix(name, value, description='')Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A keveredési mátrix neve. |
|
value
Kötelező
|
Név- és verzió- és adattulajdonságokat tartalmazó JSON. |
|
description
Kötelező
|
Választható metrikaleírás. |
Megjegyzések
Példa érvényes JSON-értékre:
{
"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
Naplózza a rendszerképmetrikát a futtatási rekordba.
log_image(name, path=None, plot=None, description='')Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A metrika neve. |
|
path
Kötelező
|
A kép elérési útja vagy adatfolyama. |
|
plot
Kötelező
|
<xref:matplotlib.pyplot>
A képként naplózandó diagram. |
|
description
Kötelező
|
Választható metrikaleírás. |
Megjegyzések
Ezzel a módszerrel naplózhat egy képfájlt vagy egy matplotlib-diagramot a futtatásra. Ezek a képek a futtatási rekordban láthatók és összehasonlíthatók lesznek.
log_list
Naplózza a metrikaértékek listáját a futtatásba a megadott névvel.
log_list(name, value, description='')Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A metrika neve. |
|
value
Kötelező
|
A metrika értékei. |
|
description
Kötelező
|
Választható metrikaleírás. |
log_predictions
Napló-előrejelzések az összetevőtárolóba.
Ez naplóz egy metrikapontszámot, amely a valódi célértékek eloszlásának összehasonlítására használható a regressziós tevékenység előrejelzett értékeinek eloszlásával.
Az előrejelzések rögzítve vannak, és a program kiszámítja a szórásokat a vonaldiagram hibasávjaihoz.
log_predictions(name, value, description='')Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
Az előrejelzések neve. |
|
value
Kötelező
|
Név- és verzió- és adattulajdonságokat tartalmazó JSON. |
|
description
Kötelező
|
Választható metrikaleírás. |
Megjegyzések
Példa érvényes JSON-értékre:
{
"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
Naplózhatja a reziduálisokat az összetevőtárolóba.
Ez naplózza a regressziós feladat reziduálisainak hisztogramjának megjelenítéséhez szükséges adatokat. A reziduálisok előrejelzése – tényleges.
A darabszámnál egynél több élnek kell lennie. Tekintse meg a numpy hisztogram dokumentációját, amely példákat tartalmaz a hisztogramok számának és éleinek ábrázolására. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html
log_residuals(name, value, description='')Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A reziduálisok neve. |
|
value
Kötelező
|
Név-, verzió- és adattulajdonságokat tartalmazó JSON. |
|
description
Kötelező
|
Választható metrikaleírás. |
Megjegyzések
Példa érvényes JSON-értékre:
{
"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
Naplózhat egy sormetrikát a futtatásba a megadott névvel.
log_row(name, description=None, **kwargs)Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A metrika neve. |
|
description
|
Választható metrikaleírás. Alapértelmezett érték: None
|
|
kwargs
Kötelező
|
További paraméterek szótára. Ebben az esetben a metrika oszlopai. |
Megjegyzések
A használatával log_row létrehoz egy táblametrikát az oszlopokkal a kwargsben leírtak szerint. Minden megnevezett paraméter létrehoz egy oszlopot a megadott értékkel.
log_row meghívható egyszer egy tetszőleges rekord naplózásához, vagy egy ciklusban többször is egy teljes tábla létrehozásához.
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
Naplózhat egy táblametrikát a futtatásba a megadott névvel.
log_table(name, value, description='')Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A metrika neve. |
|
value
Kötelező
|
A metrika táblaértéke, egy szótár, amelyben a kulcsok a szolgáltatásban közzéteendő oszlopok. |
|
description
Kötelező
|
Választható metrikaleírás. |
register_model
Modell regisztrálása az üzembe helyezéshez.
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)Paraméterek
| Name | Description |
|---|---|
|
model_name
Kötelező
|
A modell neve. |
|
model_path
|
A modell relatív felhőbeli elérési útja, például "outputs/modelname".
Ha nincs megadva (Nincs), Alapértelmezett érték: None
|
|
tags
|
A modellhez hozzárendelendő kulcsértékcímkék szótára. Alapértelmezett érték: None
|
|
properties
|
A modellhez hozzárendelendő kulcsérték-tulajdonságok szótára. Ezek a tulajdonságok a modell létrehozása után nem módosíthatók, de új kulcsértékpárok is hozzáadhatók. Alapértelmezett érték: None
|
|
model_framework
|
A regisztrálandó modell keretrendszere. Jelenleg támogatott keretrendszerek: TensorFlow, ScikitLearn, Onnx, Custom, Multi Alapértelmezett érték: None
|
|
model_framework_version
|
A regisztrált modell keretrendszerverziója. Alapértelmezett érték: None
|
|
description
|
A modell opcionális leírása. Alapértelmezett érték: None
|
|
datasets
|
Azon rekordok listája, ahol az első elem az adathalmaz-modell kapcsolatot írja le, a második elem pedig az adathalmaz. Alapértelmezett érték: None
|
|
sample_input_dataset
|
Választható. Minta bemeneti adatkészlet a regisztrált modellhez Alapértelmezett érték: None
|
|
sample_output_dataset
|
Választható. Minta kimeneti adatkészlet a regisztrált modellhez Alapértelmezett érték: None
|
|
resource_configuration
|
Választható. Erőforrás-konfiguráció a regisztrált modell futtatásához Alapértelmezett érték: None
|
|
kwargs
Kötelező
|
Választható paraméterek. |
Válaszok
| Típus | Description |
|---|---|
|
A regisztrált modell. |
Megjegyzések
model = best_run.register_model(model_name = 'best_model', model_path = 'outputs/model.pkl')
remove_tags
Törölje a futtatáskor a táblacímkék listáját.
remove_tags(tags)Paraméterek
| Name | Description |
|---|---|
|
tags
Kötelező
|
Az eltávolítandó címkék listája. |
Válaszok
| Típus | Description |
|---|---|
|
A futtatási objektumon tárolt címkék |
restore_snapshot
Pillanatkép visszaállítása ZIP-fájlként. A ZIP elérési útját adja vissza.
restore_snapshot(snapshot_id=None, path=None)Paraméterek
| Name | Description |
|---|---|
|
snapshot_id
|
A visszaállítani kívánt pillanatkép-azonosító. A rendszer a legújabbat használja, ha nincs megadva. Alapértelmezett érték: None
|
|
path
|
A letöltött ZIP mentési útvonala. Alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
Az elérési út. |
set_tags
Adjon hozzá vagy módosítson egy címkekészletet a futtatáskor. A szótárban nem átadott címkék érintetlenek maradnak.
Egyszerű sztringcímkéket is hozzáadhat. Ha ezek a címkék kulcsokként jelennek meg a címkeszótárban, akkor a Nincs értékkel rendelkeznek. További információ: Futtatások címkézése és keresése.
set_tags(tags)Paraméterek
| Name | Description |
|---|---|
|
tags
Kötelező
|
A futtatási objektumban tárolt címkék. |
start
A futtatás megjelölése indításként.
Ezt általában speciális forgatókönyvekben használják, ha a futtatást egy másik szereplő hozta létre.
start()submit_child
Küldjön be egy kísérletet, és adja vissza az aktív gyermekfuttatást.
submit_child(config, tags=None, **kwargs)Paraméterek
| Name | Description |
|---|---|
|
config
Kötelező
|
Az elküldendő konfiguráció. |
|
tags
|
A beküldött futtatáshoz hozzáadandó címkék, pl. {"tag": "value"}. Alapértelmezett érték: None
|
|
kwargs
Kötelező
|
A submit függvény konfigurációihoz használt további paraméterek. |
Válaszok
| Típus | Description |
|---|---|
|
Egy futtatási objektum. |
Megjegyzések
A Submit egy aszinkron hívás az Azure Machine Learning platformra a próbaverzió helyi vagy távoli hardveren való végrehajtásához. A konfigurációtól függően a submit automatikusan előkészíti a végrehajtási környezeteket, végrehajtja a kódot, és rögzíti a forráskódot és az eredményeket a kísérlet futtatási előzményeiben.
Kísérlet elküldéséhez először létre kell hoznia egy konfigurációs objektumot, amely leírja a kísérlet futtatásának módját. A konfiguráció a szükséges próbaverzió típusától függ.
Példa arra, hogyan küldhet be gyermekkísérletet a helyi gépről ScriptRunConfig a következő módon:
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()
A futtatás konfigurálásával kapcsolatos részletekért lásd: submit.
tag
A futtatás címkézése sztringkulccsal és opcionális sztringértékkel.
tag(key, value=None)Paraméterek
| Name | Description |
|---|---|
|
key
Kötelező
|
A címkekulcs |
|
value
|
A címke opcionális értéke Alapértelmezett érték: None
|
Megjegyzések
A futtatáson lévő címkék és tulajdonságok a sztring szótárai –> sztring. A kettő közötti különbség a módosíthatóság: A címkék beállíthatók, frissíthetők és törölhetők, míg a Tulajdonságok csak hozzáadhatók. Ez a tulajdonságokat megfelelőbbé teszi a rendszerhez/munkafolyamathoz kapcsolódó viselkedési eseményindítókhoz, míg a címkék általában felhasználói és jelentéssel bíróak a kísérlet felhasználói számára.
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
Mentse a bemeneti fájl vagy mappa pillanatképét.
take_snapshot(file_or_folder_path)Paraméterek
| Name | Description |
|---|---|
|
file_or_folder_path
Kötelező
|
A futtatási forráskódot tartalmazó fájl vagy mappa. |
Válaszok
| Típus | Description |
|---|---|
|
A pillanatkép-azonosítót adja vissza. |
Megjegyzések
A pillanatképek a kísérletfuttatás végrehajtásához használt forráskódok . Ezeket a futtatás tárolja, hogy a futtatási próbaverzió a jövőben replikálható legyen.
Megjegyzés
A rendszer a híváskor submit automatikusan pillanatképeket vesz fel. Ez a take_snapshot módszer általában csak az interaktív (jegyzetfüzet)-futtatásokhoz szükséges.
upload_file
Töltsön fel egy fájlt a futtatási rekordba.
upload_file(name, path_or_stream, datastore_name=None)Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A feltöltendő fájl neve. |
|
path_or_stream
Kötelező
|
A feltöltendő fájl relatív helyi elérési útja vagy streamelése. |
|
datastore_name
Kötelező
|
Nem kötelező adattároló neve |
Válaszok
| Típus | Description |
|---|---|
Megjegyzések
run = experiment.start_logging()
run.upload_file(name='important_file', path_or_stream="path/on/disk/file.txt")
Megjegyzés
A futtatások automatikusan rögzítik a fájlt a megadott kimeneti könyvtárban, amely alapértelmezés szerint "./outputs" lesz a legtöbb futtatási típus esetében. Csak akkor használja upload_file, ha további fájlokat kell feltölteni, vagy nincs megadva kimeneti könyvtár.
upload_files
Fájlok feltöltése a futtatási rekordba.
upload_files(names, paths, return_artifacts=False, timeout_seconds=None, datastore_name=None)Paraméterek
| Name | Description |
|---|---|
|
names
Kötelező
|
A feltöltendő fájlok neve. Ha be van állítva, az elérési utakat is be kell állítani. |
|
paths
Kötelező
|
A feltöltendő fájlok relatív helyi elérési útjai. Ha be van állítva, a nevek megadása kötelező. |
|
return_artifacts
Kötelező
|
Azt jelzi, hogy minden feltöltött fájlhoz egy összetevő-objektumot kell visszaadni. |
|
timeout_seconds
Kötelező
|
A fájlok feltöltésének időtúllépése. |
|
datastore_name
Kötelező
|
Nem kötelező adattároló neve |
Megjegyzések
upload_files ugyanolyan hatással van, mint upload_file a különálló fájlokra, azonban a használata upload_filesteljesítmény- és erőforrás-kihasználtsági előnyökkel jár.
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')
Megjegyzés
A futtatások automatikusan rögzítik a fájlokat a megadott kimeneti könyvtárban, amely alapértelmezés szerint "./outputs" a legtöbb futtatási típus esetében. Csak akkor használja upload_files, ha további fájlokat kell feltölteni, vagy nincs megadva kimeneti könyvtár.
upload_folder
Töltse fel a megadott mappát a megadott előtag nevére.
upload_folder(name, path, datastore_name=None)Paraméterek
| Name | Description |
|---|---|
|
name
Kötelező
|
A feltöltendő fájlok mappájának neve. |
|
folder
Kötelező
|
A feltölteni kívánt mappa relatív helyi elérési útja. |
|
datastore_name
Kötelező
|
Nem kötelező adattároló neve |
Megjegyzések
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')
Megjegyzés
A futtatások automatikusan rögzítik a fájlokat a megadott kimeneti könyvtárban, amely alapértelmezés szerint "./outputs" a legtöbb futtatási típus esetében. Csak akkor használja upload_folder, ha további fájlokat kell feltölteni, vagy nincs megadva kimeneti könyvtár.
wait_for_completion
Várja meg a futtatás befejezését. A várakozás után visszaadja az állapotobjektumot.
wait_for_completion(show_output=False, wait_post_processing=False, raise_on_error=True)Paraméterek
| Name | Description |
|---|---|
|
show_output
|
Azt jelzi, hogy meg szeretné-e jeleníteni a futtatási kimenetet a sys.stdout-on. Alapértelmezett érték: False
|
|
wait_post_processing
|
Azt jelzi, hogy megvárja-e a feldolgozás utáni befejezést a futtatás befejezése után. Alapértelmezett érték: False
|
|
raise_on_error
|
Azt jelzi, hogy hiba jelenik-e meg, ha a futtatás sikertelen állapotban van. Alapértelmezett érték: True
|
Válaszok
| Típus | Description |
|---|---|
|
Az állapotobjektum. |
Attribútumok
description
Adja vissza a futtatás leírását.
A futtatás opcionális leírása egy felhasználó által megadott sztring, amely hasznos a futtatás leírásához.
Válaszok
| Típus | Description |
|---|---|
|
A futtatás leírása. |
display_name
Adja vissza a futtatás megjelenítendő nevét.
A futtatás opcionális megjelenítendő neve egy felhasználó által megadott sztring, amely hasznos a futtatás későbbi azonosításához.
Válaszok
| Típus | Description |
|---|---|
|
A futtatás megjelenítendő neve. |
experiment
A futtatást tartalmazó kísérlet lekérése.
Válaszok
| Típus | Description |
|---|---|
|
Lekéri a futtatásnak megfelelő kísérletet. |
id
Lekérheti a futtatási azonosítót.
A futtatás azonosítója a benne található kísérletben egyedi azonosító.
Válaszok
| Típus | Description |
|---|---|
|
A futtatási azonosító. |
name
ELAVULT. Használja display_name.
A futtatás opcionális neve egy felhasználó által megadott sztring, amely a futtatás későbbi azonosításához használható.
Válaszok
| Típus | Description |
|---|---|
|
A futtatási azonosító. |
number
Futtatási szám lekérése.
Egy monoton módon növekvő szám, amely egy kísérlet futtatási sorrendjét jelöli.
Válaszok
| Típus | Description |
|---|---|
|
A futtatási szám. |
parent
A szülőfuttatás lekérése ehhez a futtatáshoz a szolgáltatásból.
A futtatások tartalmazhatnak opcionális szülőt, amely a futtatások lehetséges fahierarchiáját eredményezi. A metrika szülőfuttatásba való naplózásához használja a log szülőobjektum metódusát, például: run.parent.log().
Válaszok
| Típus | Description |
|---|---|
|
A szülő fut, vagy Nincs, ha nincs beállítva. |
properties
Adja vissza a futtatás nem módosítható tulajdonságait.
Válaszok
| Típus | Description |
|---|---|
|
A futtatás helyileg gyorsítótárazott tulajdonságai. |
Megjegyzések
A tulajdonságok közé tartoznak a rendszer által generált nem módosítható információk, például az időtartam, a végrehajtás dátuma, a felhasználó stb.
status
Adja vissza a futtatási objektum állapotát.
tags
Adja vissza a futtatás során a táblacímkék készletét.
Válaszok
| Típus | Description |
|---|---|
|
A futtatási objektumon tárolt címkék. |
type
Futtatási típus lekérése.
A futtatás létrehozásának vagy konfigurálásának módját jelzi.
Válaszok
| Típus | Description |
|---|---|
|
A futtatás típusa. |