Run Klass

  • Referens

Definierar basklassen för alla Azure Machine Learning-experimentkörningar.

En körning representerar en enda utvärderingsversion av ett experiment. Körningar används för att övervaka den asynkrona körningen av en utvärderingsversion, logga mått och lagra utdata från utvärderingsversionen samt för att analysera resultat och få åtkomst till artefakter som genereras av utvärderingsversionen.

Körningsobjekt skapas när du skickar ett skript för att träna en modell i många olika scenarier i Azure Machine Learning, inklusive HyperDrive-körningar, pipelinekörningar och AutoML-körningar. Ett Kör-objekt skapas också när du submit eller start_logging med Experiment klassen .

Information om hur du kommer igång med experiment och körningar finns i

Initiera Run-objektet.

Arv
azureml._run_impl.run_base._RunBase
Run

Konstruktor

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

Parametrar

Name Description
experiment
Obligatorisk
Experiment

Det innehållande experimentet.
run_id
Obligatorisk
str

ID:t för körningen.
outputs
str

Utdata som ska spåras.

standardvärde: None
_run_dto
Obligatorisk
<xref:azureml._restclient.models.run_dto.RunDto>

Endast internt bruk.
kwargs
Obligatorisk
dict

En ordlista med ytterligare konfigurationsparametrar.
experiment
Obligatorisk
Experiment

Det innehållande experimentet.
run_id
Obligatorisk
str

ID:t för körningen.
outputs
Obligatorisk
str

Utdata som ska spåras.
kwargs
Obligatorisk
dict

En ordlista med ytterligare konfigurationsparametrar.

Kommentarer

En körning representerar en enda utvärderingsversion av ett experiment. Ett Körningsobjekt används för att övervaka den asynkrona körningen av en utvärderingsversion, logga mått och lagra utdata från utvärderingsversionen samt för att analysera resultat och få åtkomst till artefakter som genereras av utvärderingsversionen.

Körningen används i experimentkoden för att logga mått och artefakter till tjänsten Körningshistorik.

Körningen används utanför experimenten för att övervaka förloppet och för att köra frågor mot och analysera de mått och resultat som genererades.

Funktionerna i Kör omfattar:

  • Lagra och hämta mått och data

  • Ladda upp och ladda ned filer

  • Använda taggar och den underordnade hierarkin för enkel sökning av tidigare körningar

  • Registrera lagrade modellfiler som en modell som kan operationaliseras

  • Lagra, ändra och hämta egenskaper för en körning

  • Läser in den aktuella körningen get_context från en fjärrmiljö med metoden

  • Effektivt ögonblicksbild av en fil eller katalog för reproducerbarhet

Den här klassen fungerar med i följande Experiment scenarier:

  • Skapa en körning genom att köra kod med hjälp av submit

  • Skapa en körning interaktivt i en notebook-fil med hjälp av start_logging

  • Logga mått och ladda upp artefakter i experimentet, till exempel när du använder log

  • Läsa mått och ladda ned artefakter när du analyserar experimentella resultat, till exempel när du använder get_metrics

Om du vill skicka en körning skapar du ett konfigurationsobjekt som beskriver hur experimentet körs. Här är exempel på de olika konfigurationsobjekt som du kan använda:

  • ScriptRunConfig

  • azureml.train.automl.automlconfig.AutoMLConfig

  • azureml.train.hyperdrive.HyperDriveConfig

  • azureml.pipeline.core.Pipeline

  • azureml.pipeline.core.PublishedPipeline

  • azureml.pipeline.core.PipelineEndpoint

Följande mått kan läggas till i en körning när du tränar ett experiment.

  • Skalär

    • Logga ett numeriskt värde eller strängvärde för körningen med det angivna namnet med hjälp av log. Om du loggar ett mått till en körning lagras måttet i körningsposten i experimentet. Du kan logga samma mått flera gånger inom en körning, vilket innebär att resultatet betraktas som en vektor för det måttet.

    • Exempel: run.log("accuracy", 0.95)

  • Lista

    • Logga en lista med värden för körningen med det angivna namnet med hjälp av log_list.

    • Exempel: run.log_list("accuracies", [0.6, 0.7, 0.87])

  • Rad

    • Med hjälp av log_row skapas ett mått med flera kolumner enligt beskrivningen i kwargs. Varje namngiven parameter genererar en kolumn med det angivna värdet. log_row kan anropas en gång för att logga en godtycklig tuppla eller flera gånger i en loop för att generera en fullständig tabell.

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

  • Tabell

    • Logga ett ordlisteobjekt till körningen med det angivna namnet med hjälp av log_table.

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

  • Bild

    • Logga en avbildning till körningsposten. Använd log_image för att logga en avbildningsfil eller ett matplotlib-diagram till körningen. Dessa avbildningar kommer att vara synliga och jämförbara i körningsposten.

    • Exempel: run.log_image("ROC", path)

Metoder

add_properties

Lägg till oföränderliga egenskaper i körningen.

Taggar och egenskaper (båda dict[str, str]) skiljer sig åt i sin föränderlighet. Egenskaper är oföränderliga, så de skapar en permanent post i granskningssyfte. Taggar är föränderliga. Mer information om hur du arbetar med taggar och egenskaper finns i Tagga och hitta körningar.
add_type_provider

Utökningsbarhetskrok för anpassade körningstyper som lagras i Körningshistorik.
cancel

Markera körningen som avbruten.

Om det finns ett associerat jobb med ett angivet cancel_uri fält avslutar du även det jobbet.
child_run

Skapa en underordnad körning.
clean

Ta bort de filer som motsvarar den aktuella körningen på det mål som anges i körningskonfigurationen.
complete

Vänta tills aktivitetskön har bearbetats.

Sedan markeras körningen som slutförd. Detta används vanligtvis i scenarier med interaktiva notebook-filer.
create_children

Skapa en eller flera underordnade körningar.
download_file

Ladda ned en associerad fil från lagringen.
download_files

Ladda ned filer från ett angivet lagringsprefix (mappnamn) eller hela containern om prefixet är ospecificerat.
fail

Markera körningen som misslyckad.

Du kan också ange egenskapen Fel för körningen med ett meddelande eller undantag som skickas till error_details.
flush

Vänta tills aktivitetskön har bearbetats.
get

Hämta körningen för den här arbetsytan med dess körnings-ID.
get_all_logs

Ladda ned alla loggar för körningen till en katalog.
get_children

Hämta alla underordnade för den aktuella körningen som valts av angivna filter.
get_context

Returnera aktuell tjänstkontext.

Använd den här metoden för att hämta den aktuella tjänstkontexten för att logga mått och ladda upp filer. Om allow_offline är True (standard) skrivs åtgärder mot Run-objektet ut som standard.
get_detailed_status

Hämta den senaste statusen för körningen. Om statusen för körningen är "Queued" (I kö) visas informationen.
get_details

Hämta definition, statusinformation, aktuella loggfiler och annan information om körningen.
get_details_with_logs

Returnera körningsstatus inklusive loggfilsinnehåll.
get_environment

Hämta miljödefinitionen som användes av den här körningen.
get_file_names

Visa en lista över de filer som lagras i samband med körningen.
get_metrics

Hämta måtten som loggats för körningen.

Om recursive är Sant (falskt som standard) hämtar du mått för körningar i den angivna körningens underträd.
get_properties

Hämta de senaste egenskaperna för körningen från tjänsten.
get_secret

Hämta det hemliga värdet från kontexten för en körning.

Hämta det hemliga värdet för det angivna namnet. Det hemliga namnet refererar till ett värde som lagras i Azure Key Vault som är associerat med din arbetsyta. Ett exempel på hur du arbetar med hemligheter finns i Använda hemligheter i träningskörningar.
get_secrets

Hämta de hemliga värdena för en viss lista med hemliga namn.

Hämta en ordlista över hittade och hittade inte hemligheter för listan med angivna namn. Varje hemligt namn refererar till ett värde som lagras i Azure Key Vault som är associerat med din arbetsyta. Ett exempel på hur du arbetar med hemligheter finns i Använda hemligheter i träningskörningar.
get_snapshot_id

Hämta det senaste ögonblicksbilds-ID:t.
get_status

Hämta den senaste statusen för körningen.

Vanliga värden som returneras är "Running", "Completed" och "Failed".
get_submitted_run

DEPRECATED. Använd get_context.

Hämta den skickade körningen för det här experimentet.
get_tags

Hämta den senaste uppsättningen föränderliga taggar på körningen från tjänsten.
list

Hämta en lista över körningar i ett experiment som anges av valfria filter.
list_by_compute

Hämta en lista över körningar i en beräkning som anges av valfria filter.
log

Logga ett måttvärde för körningen med det angivna namnet.
log_accuracy_table

Logga en noggrannhetstabell till artefaktarkivet.

Precisionstabellmåttet är ett icke-skalärt mått med flera användningsområden som kan användas för att skapa flera typer av linjediagram som kontinuerligt varierar över utrymmet för förutsagda sannolikheter. Exempel på dessa diagram är ROC, precisionsåterkallelse och lyftkurvor.

Beräkningen av noggrannhetstabellen liknar beräkningen av en ROC-kurva. En ROC-kurva lagrar sanna positiva värden och falska positiva värden vid många olika sannolikhetströsklar. Noggrannhetstabellen lagrar det råa antalet sanna positiva identifieringar, falska positiva identifieringar, sanna negativa och falska negativa värden vid många sannolikhetströsklar.

Det finns två metoder som används för att välja tröskelvärden: "sannolikhet" och "percentil". De skiljer sig åt i hur de samplas från utrymmet för förutsagda sannolikheter.

Sannolikhetströsklar är jämnt fördelade tröskelvärden mellan 0 och 1. Om NUM_POINTS är 5 är sannolikhetströskelvärdena [0,0, 0,25, 0,5, 0,75, 1,0].

Percentiltrösklar är fördelade enligt fördelningen av förutsagda sannolikheter. Varje tröskelvärde motsvarar percentilen av data vid ett sannolikhetströskelvärde. Om NUM_POINTS till exempel är 5 är det första tröskelvärdet den 0:e percentilen, den andra vid den 25:e percentilen, den tredje på den 50:e och så vidare.

Sannolikhetstabellerna och percentiltabellerna är båda 3D-listor där den första dimensionen representerar klassetiketten, den andra dimensionen representerar exemplet vid ett tröskelvärde (skalar med NUM_POINTS) och den tredje dimensionen har alltid 4 värden: TP, FP, TN, FN och alltid i den ordningen.

Förvirringsvärdena (TP, FP, TN, FN) beräknas med strategin one vs. rest. Mer information finns i följande länk: https://en.wikipedia.org/wiki/Multiclass_classification

N = antal exempel i valideringsdatauppsättningen (200 i exempel) M = # tröskelvärden = # exempel tagna från sannolikhetsutrymmet (5 i exempel) C = # klasser i fullständig datamängd (3 i exempel)

Några invarianter i precisionstabellen:

  • TP + FP + TN + FN = N för alla tröskelvärden för alla klasser
  • TP + FN är samma vid alla tröskelvärden för alla klasser
  • TN + FP är samma vid alla tröskelvärden för alla klasser
  • Sannolikhetstabeller och percentiltabeller har form [C, M, 4]

Obs! M kan vara valfritt värde och styr upplösningen för diagrammen Detta är oberoende av datauppsättningen, definieras vid beräkning av mått och avväger lagringsutrymme, beräkningstid och lösning.

Klassetiketter ska vara strängar, felvärden ska vara heltal och tröskelvärden ska vara flyttal.
log_confusion_matrix

Logga en förvirringsmatris till artefaktarkivet.

Detta loggar en omslutning runt sklearn-förvirringsmatrisen. Måttdata innehåller klassetiketterna och en 2D-lista för själva matrisen. Se följande länk för mer information om hur måttet beräknas: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html
log_image

Logga ett avbildningsmått till körningsposten.
log_list

Logga en lista med måttvärden för körningen med det angivna namnet.
log_predictions

Logga förutsägelser till artefaktarkivet.

Detta loggar en måttpoäng som kan användas för att jämföra fördelningarna av sanna målvärden med fördelningen av förutsagda värden för en regressionsaktivitet.

Förutsägelserna är binerade och standardavvikelser beräknas för felstaplar i ett linjediagram.
log_residuals

Logga residualer till artefaktarkivet.

Detta loggar de data som behövs för att visa ett histogram över residualer för en regressionsaktivitet. Residualerna förutsägs - faktiska.

Det bör finnas en mer kant än antalet. Se dokumentationen för numpy histogram för exempel på hur du använder antal och kanter för att representera ett histogram. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html
log_row

Logga ett radmått för körningen med det angivna namnet.
log_table

Logga ett tabellmått för körningen med det angivna namnet.
register_model

Registrera en modell för driftsättning.
remove_tags

Ta bort listan över föränderliga taggar på den här körningen.
restore_snapshot

Återställa en ögonblicksbild som en ZIP-fil. Returnerar sökvägen till ZIP.
set_tags

Lägg till eller ändra en uppsättning taggar på körningen. Taggar som inte skickas i ordlistan lämnas orörda.

Du kan också lägga till enkla strängtaggar. När dessa taggar visas i taggordlistan som nycklar har de värdet Ingen. Mer information finns i Tagga och hitta körningar.
start

Markera körningen som startad.

Detta används vanligtvis i avancerade scenarier när körningen har skapats av en annan aktör.
submit_child

Skicka ett experiment och returnera den aktiva underordnade körningen.
tag

Tagga körningen med en strängnyckel och ett valfritt strängvärde.
take_snapshot

Spara en ögonblicksbild av indatafilen eller mappen.
upload_file

Ladda upp en fil till körningsposten.
upload_files

Ladda upp filer till körningsposten.
upload_folder

Ladda upp den angivna mappen till det angivna prefixnamnet.
wait_for_completion

Vänta tills körningen har slutförts. Returnerar statusobjektet efter väntetiden.

add_properties

Lägg till oföränderliga egenskaper i körningen.

Taggar och egenskaper (båda dict[str, str]) skiljer sig åt i sin föränderlighet. Egenskaper är oföränderliga, så de skapar en permanent post i granskningssyfte. Taggar är föränderliga. Mer information om hur du arbetar med taggar och egenskaper finns i Tagga och hitta körningar.

add_properties(properties)

Parametrar

Name Description
properties
Obligatorisk
dict

De dolda egenskaperna som lagras i körningsobjektet.

add_type_provider

Utökningsbarhetskrok för anpassade körningstyper som lagras i Körningshistorik.

static add_type_provider(runtype, run_factory)

Parametrar

Name Description
runtype
Obligatorisk
str

Värdet för Run.type som fabriken ska anropas för. Exempel är "hyperdrive" eller "azureml.scriptrun", men kan utökas med anpassade typer.
run_factory
Obligatorisk
<xref:function>

En funktion med signatur (Experiment, RunDto) –> Kör som ska anropas när listan körs.

cancel

Markera körningen som avbruten.

Om det finns ett associerat jobb med ett angivet cancel_uri fält avslutar du även det jobbet.

cancel()

child_run

Skapa en underordnad körning.

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

Parametrar

Name Description
name
str

Ett valfritt namn för den underordnade körningen, som vanligtvis anges för en "del".

standardvärde: None
run_id
str

Ett valfritt körnings-ID för det underordnade, annars genereras det automatiskt. Den här parametern är vanligtvis inte inställd.

standardvärde: None
outputs
str

Valfri utdatakatalog som ska spåras för den underordnade.

standardvärde: None

Returer

Typ Description
Run

Den underordnade körningen.

Kommentarer

Detta används för att isolera en del av en körning till ett underavsnitt. Detta kan göras för identifierbara "delar" av en körning som är intressant att separera, eller för att samla in oberoende mått över en interation av en underprocess.

Om en utdatakatalog har angetts för den underordnade körningen laddas innehållet i katalogen upp till den underordnade körningsposten när det underordnade objektet har slutförts.

clean

Ta bort de filer som motsvarar den aktuella körningen på det mål som anges i körningskonfigurationen.

clean()

Returer

Typ Description
list

En lista över filer som tagits bort.

complete

Vänta tills aktivitetskön har bearbetats.

Sedan markeras körningen som slutförd. Detta används vanligtvis i scenarier med interaktiva notebook-filer.

complete(_set_status=True)

Parametrar

Name Description
_set_status
bool

Anger om statushändelsen ska skickas för spårning.

standardvärde: True

create_children

Skapa en eller flera underordnade körningar.

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

Parametrar

Name Description
count
int

Ett valfritt antal underordnade att skapa.

standardvärde: None
tag_key
str

En valfri nyckel för att fylla i posten Taggar i alla skapade underordnade.

standardvärde: None
tag_Values
Obligatorisk

En valfri lista med värden som ska mappas till Taggar[tag_key] för listan över körningar som skapats.
tag_values
standardvärde: None

Returer

Typ Description
list[Run]

Listan över underordnade körningar.

Kommentarer

Antingen parametern count ELLER parametrarNA tag_key AND tag_values måste anges.

download_file

Ladda ned en associerad fil från lagringen.

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

Parametrar

Name Description
name
Obligatorisk
str

Namnet på artefakten som ska laddas ned.
output_file_path
Obligatorisk
str

Den lokala sökvägen där artefakten ska lagras.

download_files

Ladda ned filer från ett angivet lagringsprefix (mappnamn) eller hela containern om prefixet är ospecificerat.

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

Parametrar

Name Description
prefix
Obligatorisk
str

Filsökvägsprefixet i containern som alla artefakter ska laddas ned från.
output_directory
Obligatorisk
str

En valfri katalog som alla artefaktsökvägar använder som prefix.
output_paths
Obligatorisk
[str]

Valfria filsökvägar där de nedladdade artefakterna ska lagras. Bör vara unikt och matcha längden på sökvägar.
batch_size
Obligatorisk
int

Antalet filer som ska laddas ned per batch. Standardvärdet är 100 filer.
append_prefix
Obligatorisk
bool

En valfri flagga om du vill lägga till det angivna prefixet från den slutliga sökvägen till utdatafilen. Om värdet är Falskt tas prefixet bort från sökvägen till utdatafilen.
timeout_seconds
Obligatorisk
int

Tidsgränsen för nedladdning av filer.

fail

Markera körningen som misslyckad.

Du kan också ange egenskapen Fel för körningen med ett meddelande eller undantag som skickas till error_details.

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

Parametrar

Name Description
error_details
str eller BaseException

Valfri information om felet.

standardvärde: None
error_code
str

Valfri felkod för felet för felklassificeringen.

standardvärde: None
_set_status
bool

Anger om statushändelsen ska skickas för spårning.

standardvärde: True

flush

Vänta tills aktivitetskön har bearbetats.

flush(timeout_seconds=300)

Parametrar

Name Description
timeout_seconds
int

Hur lång tid ska du vänta (i sekunder) på att uppgiftskö ska bearbetas.

standardvärde: 300

get

Hämta körningen för den här arbetsytan med dess körnings-ID.

static get(workspace, run_id)

Parametrar

Name Description
workspace
Obligatorisk
Workspace

Den innehållande arbetsytan.
run_id
Obligatorisk
string

Körnings-ID:t.

Returer

Typ Description
Run

Den skickade körningen.

get_all_logs

Ladda ned alla loggar för körningen till en katalog.

get_all_logs(destination=None)

Parametrar

Name Description
destination
str

Målsökvägen för att lagra loggar. Om den är ospecificerad skapas en katalog med namnet som körnings-ID i projektkatalogen.

standardvärde: None

Returer

Typ Description
list

En lista över namn på loggar som laddats ned.

get_children

Hämta alla underordnade för den aktuella körningen som valts av angivna filter.

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

Parametrar

Name Description
recursive
bool

Anger om du vill upprepa genom alla underordnade.

standardvärde: False
tags
str eller dict

Om det anges returneras körningar som matchar angiven "tag" eller {"tag": "value"}.

standardvärde: None
properties
str eller dict

Om det anges returneras körningar som matchar angiven "egenskap" eller {"egenskap": "value"}.

standardvärde: None
type
str

Om det anges returneras körningar som matchar den här typen.

standardvärde: None
status
str

Om det anges returneras körningar med status angiven "status".

standardvärde: None
_rehydrate_runs
bool

Anger om du vill instansiera en körning av den ursprungliga typen eller baskörningen.

standardvärde: True

Returer

Typ Description
list

En lista över Run objekt.

get_context

Returnera aktuell tjänstkontext.

Använd den här metoden för att hämta den aktuella tjänstkontexten för att logga mått och ladda upp filer. Om allow_offline är True (standard) skrivs åtgärder mot Run-objektet ut som standard.

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

Parametrar

Name Description
cls
Obligatorisk

Anger klassmetod.
allow_offline
bool

Tillåt att tjänstkontexten återgår till offlineläge så att träningsskriptet kan testas lokalt utan att skicka ett jobb med SDK:et. Sant som standard.

standardvärde: True
kwargs
Obligatorisk
dict

En ordlista med ytterligare parametrar.
used_for_context_manager
standardvärde: False

Returer

Typ Description
Run

Den skickade körningen.

Kommentarer

Den här funktionen används ofta för att hämta det autentiserade Run-objektet i ett skript som ska skickas för körning via experiment.submit(). Det här körningsobjektet är både en autentiserad kontext för att kommunicera med Azure Machine Learning-tjänster och en konceptuell container där mått, filer (artefakter) och modeller finns.


   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

Hämta den senaste statusen för körningen. Om statusen för körningen är "Queued" (I kö) visas informationen.

get_detailed_status()

Returer

Typ Description
dict[str, str]

Den senaste statusen och informationen

Kommentarer

  • status: Körningens aktuella status. Samma värde som det som returnerades från get_status().

  • details: Detaljerad information för aktuell status.


   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

Hämta definition, statusinformation, aktuella loggfiler och annan information om körningen.

get_details()

Returer

Typ Description
dict[str, str]

Returnera information om körningen

Kommentarer

Den returnerade ordlistan innehåller följande nyckel/värde-par:

  • runId: ID för den här körningen.

  • Mål

  • status: Körningens aktuella status. Samma värde som det som returnerades från get_status().

  • startTimeUtc: UTC-tiden då den här körningen startades, i ISO8601.

  • endTimeUtc: UTC-tid då den här körningen slutfördes (antingen slutförd eller misslyckades) i ISO8601.

    Den här nyckeln finns inte om körningen fortfarande pågår.

  • egenskaper: Oföränderliga nyckel/värde-par som är associerade med körningen. Standardegenskaperna omfattar körningens ögonblicksbilds-ID och information om git-lagringsplatsen som körningen skapades från (om någon). Ytterligare egenskaper kan läggas till i en körning med hjälp av add_properties.

  • inputDatasets: Indatauppsättningar som är associerade med körningen.

  • outputDatasets: Utdatauppsättningar som är associerade med körningen.

  • Loggfiler

  • 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

Returnera körningsstatus inklusive loggfilsinnehåll.

get_details_with_logs()

Returer

Typ Description
dict

Returnerar status för körningen med loggfilsinnehåll.

get_environment

Hämta miljödefinitionen som användes av den här körningen.

get_environment()

Returer

Typ Description
Environment

Returnera miljöobjektet.

get_file_names

Visa en lista över de filer som lagras i samband med körningen.

get_file_names()

Returer

Typ Description
list[str]

Listan över sökvägar för befintliga artefakter

get_metrics

Hämta måtten som loggats för körningen.

Om recursive är Sant (falskt som standard) hämtar du mått för körningar i den angivna körningens underträd.

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

Parametrar

Name Description
name
str

Namnet på måttet.

standardvärde: None
recursive
bool

Anger om du vill upprepa genom alla underordnade.

standardvärde: False
run_type
str
standardvärde: None
populate
bool

Anger om innehållet i externa data som är länkade till måttet ska hämtas.

standardvärde: False

Returer

Typ Description
dict

En ordlista som innehåller användarmåtten.

Kommentarer


   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

Hämta de senaste egenskaperna för körningen från tjänsten.

get_properties()

Returer

Typ Description
dict

Egenskaperna för körningen.

Kommentarer

Egenskaper är oföränderlig systemgenererad information, till exempel varaktighet, körningsdatum, användare och anpassade egenskaper som läggs till med add_properties metoden . Mer information finns i Tagga och hitta körningar.

Om källfiler lagras på en lokal git-lagringsplats när du skickar ett jobb till Azure Machine Learning lagras information om lagringsplatsen som egenskaper. Dessa git-egenskaper läggs till när du skapar en körning eller anropar Experiment.submit. Mer information om git-egenskaper finns i Git-integrering för Azure Machine Learning.

get_secret

Hämta det hemliga värdet från kontexten för en körning.

Hämta det hemliga värdet för det angivna namnet. Det hemliga namnet refererar till ett värde som lagras i Azure Key Vault som är associerat med din arbetsyta. Ett exempel på hur du arbetar med hemligheter finns i Använda hemligheter i träningskörningar.

get_secret(name)

Parametrar

Name Description
name
Obligatorisk
str

Det hemliga namn som en hemlighet ska returneras för.

Returer

Typ Description
str

Det hemliga värdet.

get_secrets

Hämta de hemliga värdena för en viss lista med hemliga namn.

Hämta en ordlista över hittade och hittade inte hemligheter för listan med angivna namn. Varje hemligt namn refererar till ett värde som lagras i Azure Key Vault som är associerat med din arbetsyta. Ett exempel på hur du arbetar med hemligheter finns i Använda hemligheter i träningskörningar.

get_secrets(secrets)

Parametrar

Name Description
secrets
Obligatorisk
list[str]

En lista med hemliga namn som hemliga värden ska returneras för.

Returer

Typ Description
dict[str: str]

Returnerar en ordlista över hittade och hittade inte hemligheter.

get_snapshot_id

Hämta det senaste ögonblicksbilds-ID:t.

get_snapshot_id()

Returer

Typ Description
str

Det senaste ögonblicksbilds-ID:t.

get_status

Hämta den senaste statusen för körningen.

Vanliga värden som returneras är "Running", "Completed" och "Failed".

get_status()

Returer

Typ Description
str

Den senaste statusen.

Kommentarer

  • NotStarted – det här är ett tillfälligt tillstånd för körningsobjekt på klientsidan innan molnöverföringen.

  • Startar – Körningen har börjat bearbetas i molnet. Anroparen har nu ett körnings-ID.

  • Etablering – returneras när beräkning på begäran skapas för ett visst jobb.

  • Förbereder – Körningsmiljön förbereds:

    • docker-avbildningsversion

    • konfiguration av conda-miljö

  • I kö – Jobbet placeras i kö i beräkningsmålet. I BatchAI är jobbet till exempel i kötillstånd

    medan du väntar på att alla begärda noder ska vara klara.

  • Körs – jobbet började köras i beräkningsmålet.

  • Slutför – Användarkoden har slutförts och körningen är i efterbearbetningssteg.

  • CancelRequested – Annullering har begärts för jobbet.

  • Slutförd – körningen slutfördes. Detta omfattar både användarkoden och körningen

    efterbearbetningssteg.

  • Misslyckades – körningen misslyckades. Vanligtvis innehåller egenskapen Error på en körning information om varför.

  • Avbryts – följer en begäran om annullering och anger att körningen nu har avbrutits.

  • Svarar inte – För körningar som har Pulsslag aktiverat har inga pulsslag nyligen skickats.


   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

DEPRECATED. Använd get_context.

Hämta den skickade körningen för det här experimentet.

get_submitted_run(**kwargs)

Returer

Typ Description
Run

Den skickade körningen.

get_tags

Hämta den senaste uppsättningen föränderliga taggar på körningen från tjänsten.

get_tags()

Returer

Typ Description
dict

Taggarna som lagras på körningsobjektet.

list

Hämta en lista över körningar i ett experiment som anges av valfria filter.

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

Parametrar

Name Description
experiment
Obligatorisk
Experiment

Det innehållande experimentet.
type
str

Om det anges returneras körningar som matchar den angivna typen.

standardvärde: None
tags
str eller dict

Om det anges returneras körningar som matchar angiven "tagg" eller {"tag": "value"}.

standardvärde: None
properties
str eller dict

Om det anges returneras körningar som matchar angiven "egenskap" eller {"egenskap": "värde"}.

standardvärde: None
status
str

Om det anges returneras körningar med status angiven "status".

standardvärde: None
include_children
bool

Om värdet är true hämtar du alla körningar, inte bara de på toppnivå.

standardvärde: False
_rehydrate_runs
bool

Om värdet är True (som standard) använder den registrerade providern för att återställa ett objekt för den typen i stället för baskörningen.

standardvärde: True

Returer

Typ Description
list[Run]

En lista över körningar.

Kommentarer

I följande kodexempel visas vissa användningsområden för list metoden.


   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

Hämta en lista över körningar i en beräkning som anges av valfria filter.

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

Parametrar

Name Description
compute
Obligatorisk
ComputeTarget

Den innehållande beräkningen.
type
str

Om det anges returneras körningar som matchar den angivna typen.

standardvärde: None
tags
str eller dict

Om det anges returneras körningar som matchar angiven "tagg" eller {"tag": "value"}.

standardvärde: None
properties
str eller dict

Om det anges returneras körningar som matchar angiven "egenskap" eller {"egenskap": "värde"}.

standardvärde: None
status
str

Om det anges returneras körningar med status angiven "status". Endast tillåtna värden är "Running" och "Queued".

standardvärde: None

Returer

Typ Description
<xref:builtin.generator>

en generator av ~_restclient.models.RunDto

log

Logga ett måttvärde för körningen med det angivna namnet.

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

Parametrar

Name Description
name
Obligatorisk
str

Namnet på måttet.
value
Obligatorisk

Det värde som ska bokföras till tjänsten.
description
Obligatorisk
str

En valfri måttbeskrivning.
step
int

En valfri axel för att ange värdeordning inom ett mått.

standardvärde: None

Kommentarer

Om du loggar ett mått till en körning lagras måttet i körningsposten i experimentet. Du kan logga samma mått flera gånger inom en körning, vilket innebär att resultatet betraktas som en vektor för det måttet. Om steget anges för ett mått måste det anges för alla värden.

log_accuracy_table

Logga en noggrannhetstabell till artefaktarkivet.

Precisionstabellmåttet är ett icke-skalärt mått med flera användningsområden som kan användas för att skapa flera typer av linjediagram som kontinuerligt varierar över utrymmet för förutsagda sannolikheter. Exempel på dessa diagram är ROC, precisionsåterkallelse och lyftkurvor.

Beräkningen av noggrannhetstabellen liknar beräkningen av en ROC-kurva. En ROC-kurva lagrar sanna positiva värden och falska positiva värden vid många olika sannolikhetströsklar. Noggrannhetstabellen lagrar det råa antalet sanna positiva identifieringar, falska positiva identifieringar, sanna negativa och falska negativa värden vid många sannolikhetströsklar.

Det finns två metoder som används för att välja tröskelvärden: "sannolikhet" och "percentil". De skiljer sig åt i hur de samplas från utrymmet för förutsagda sannolikheter.

Sannolikhetströsklar är jämnt fördelade tröskelvärden mellan 0 och 1. Om NUM_POINTS är 5 är sannolikhetströskelvärdena [0,0, 0,25, 0,5, 0,75, 1,0].

Percentiltrösklar är fördelade enligt fördelningen av förutsagda sannolikheter. Varje tröskelvärde motsvarar percentilen av data vid ett sannolikhetströskelvärde. Om NUM_POINTS till exempel är 5 är det första tröskelvärdet den 0:e percentilen, den andra vid den 25:e percentilen, den tredje på den 50:e och så vidare.

Sannolikhetstabellerna och percentiltabellerna är båda 3D-listor där den första dimensionen representerar klassetiketten, den andra dimensionen representerar exemplet vid ett tröskelvärde (skalar med NUM_POINTS) och den tredje dimensionen har alltid 4 värden: TP, FP, TN, FN och alltid i den ordningen.

Förvirringsvärdena (TP, FP, TN, FN) beräknas med strategin one vs. rest. Mer information finns i följande länk: https://en.wikipedia.org/wiki/Multiclass_classification

N = antal exempel i valideringsdatauppsättningen (200 i exempel) M = # tröskelvärden = # exempel tagna från sannolikhetsutrymmet (5 i exempel) C = # klasser i fullständig datamängd (3 i exempel)

Några invarianter i precisionstabellen:

  • TP + FP + TN + FN = N för alla tröskelvärden för alla klasser
  • TP + FN är samma vid alla tröskelvärden för alla klasser
  • TN + FP är samma vid alla tröskelvärden för alla klasser
  • Sannolikhetstabeller och percentiltabeller har form [C, M, 4]

Obs! M kan vara valfritt värde och styr upplösningen för diagrammen Detta är oberoende av datauppsättningen, definieras vid beräkning av mått och avväger lagringsutrymme, beräkningstid och lösning.

Klassetiketter ska vara strängar, felvärden ska vara heltal och tröskelvärden ska vara flyttal.

log_accuracy_table(name, value, description='')

Parametrar

Name Description
name
Obligatorisk
str

Namnet på precisionstabellen.
value
Obligatorisk
str eller dict

JSON som innehåller egenskaper för namn, version och data.
description
Obligatorisk
str

En valfri måttbeskrivning.

Kommentarer

Exempel på ett giltigt JSON-värde:


   {
       "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

Logga en förvirringsmatris till artefaktarkivet.

Detta loggar en omslutning runt sklearn-förvirringsmatrisen. Måttdata innehåller klassetiketterna och en 2D-lista för själva matrisen. Se följande länk för mer information om hur måttet beräknas: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html

log_confusion_matrix(name, value, description='')

Parametrar

Name Description
name
Obligatorisk
str

Namnet på förvirringsmatrisen.
value
Obligatorisk
str eller dict

JSON som innehåller egenskaper för namn, version och data.
description
Obligatorisk
str

En valfri måttbeskrivning.

Kommentarer

Exempel på ett giltigt JSON-värde:


   {
       "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

Logga ett avbildningsmått till körningsposten.

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

Parametrar

Name Description
name
Obligatorisk
str

Namnet på måttet.
path
Obligatorisk
str

Sökvägen eller strömmen till bilden.
plot
Obligatorisk
<xref:matplotlib.pyplot>

Diagrammet som ska loggas som en bild.
description
Obligatorisk
str

En valfri måttbeskrivning.

Kommentarer

Använd den här metoden för att logga en bildfil eller ett matplotlib-diagram till körningen. Dessa avbildningar kommer att vara synliga och jämförbara i körningsposten.

log_list

Logga en lista med måttvärden för körningen med det angivna namnet.

log_list(name, value, description='')

Parametrar

Name Description
name
Obligatorisk
str

Namnet på måttet.
value
Obligatorisk
list

Värdena för måttet.
description
Obligatorisk
str

En valfri måttbeskrivning.

log_predictions

Logga förutsägelser till artefaktarkivet.

Detta loggar en måttpoäng som kan användas för att jämföra fördelningarna av sanna målvärden med fördelningen av förutsagda värden för en regressionsaktivitet.

Förutsägelserna är binerade och standardavvikelser beräknas för felstaplar i ett linjediagram.

log_predictions(name, value, description='')

Parametrar

Name Description
name
Obligatorisk
str

Namnet på förutsägelserna.
value
Obligatorisk
str eller dict

JSON som innehåller egenskaper för namn, version och data.
description
Obligatorisk
str

En valfri måttbeskrivning.

Kommentarer

Exempel på ett giltigt JSON-värde:


   {
       "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

Logga residualer till artefaktarkivet.

Detta loggar de data som behövs för att visa ett histogram över residualer för en regressionsaktivitet. Residualerna förutsägs - faktiska.

Det bör finnas en mer kant än antalet. Se dokumentationen för numpy histogram för exempel på hur du använder antal och kanter för att representera ett histogram. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html

log_residuals(name, value, description='')

Parametrar

Name Description
name
Obligatorisk
str

Namnet på residualerna.
value
Obligatorisk
str eller dict

JSON som innehåller egenskaper för namn, version och data.
description
Obligatorisk
str

En valfri måttbeskrivning.

Kommentarer

Exempel på ett giltigt JSON-värde:


   {
       "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

Logga ett radmått för körningen med det angivna namnet.

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

Parametrar

Name Description
name
Obligatorisk
str

Namnet på måttet.
description
str

En valfri måttbeskrivning.

standardvärde: None
kwargs
Obligatorisk
dict

En ordlista med ytterligare parametrar. I det här fallet kolumnerna i måttet.

Kommentarer

Med hjälp av log_row skapas ett tabellmått med kolumner enligt beskrivningen i kwargs. Varje namngiven parameter genererar en kolumn med det angivna värdet. log_row kan anropas en gång för att logga en godtycklig tuppeln eller flera gånger i en loop för att generera en fullständig tabell.


   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

Logga ett tabellmått för körningen med det angivna namnet.

log_table(name, value, description='')

Parametrar

Name Description
name
Obligatorisk
str

Namnet på måttet.
value
Obligatorisk
dict

Tabellvärdet för måttet, en ordlista där nycklar är kolumner som ska publiceras till tjänsten.
description
Obligatorisk
str

En valfri måttbeskrivning.

register_model

Registrera en modell för driftsättning.

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)

Parametrar

Name Description
model_name
Obligatorisk
str

Namnet på modellen.
model_path
str

Den relativa molnsökvägen till modellen, till exempel "outputs/modelname". När det inte anges (Ingen) model_name används som sökväg.

standardvärde: None
tags
dict[str, str]

En ordlista med nyckelvärdetaggar som ska tilldelas till modellen.

standardvärde: None
properties
dict[str, str]

En ordlista med nyckelvärdeegenskaper som ska tilldelas till modellen. Dessa egenskaper kan inte ändras när modellen har skapats, men nya nyckelvärdepar kan läggas till.

standardvärde: None
model_framework
str

Ramverket för den modell som ska registreras. Ramverk som stöds för närvarande: TensorFlow, ScikitLearn, Onnx, Custom, Multi

standardvärde: None
model_framework_version
str

Ramverksversionen av den registrerade modellen.

standardvärde: None
description
str

En valfri beskrivning av modellen.

standardvärde: None
datasets
list[(str, AbstractDataset)]

En lista över tupplar där det första elementet beskriver relationen mellan datauppsättning och modell och det andra elementet är datauppsättningen.

standardvärde: None
sample_input_dataset
AbstractDataset

Valfritt. Exempel på indatauppsättning för den registrerade modellen

standardvärde: None
sample_output_dataset
AbstractDataset

Valfritt. Exempel på utdatauppsättning för den registrerade modellen

standardvärde: None
resource_configuration
ResourceConfiguration

Valfritt. Resurskonfiguration för att köra den registrerade modellen

standardvärde: None
kwargs
Obligatorisk
dict

Valfria parametrar.

Returer

Typ Description
Model

Den registrerade modellen.

Kommentarer


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

remove_tags

Ta bort listan över föränderliga taggar på den här körningen.

remove_tags(tags)

Parametrar

Name Description
tags
Obligatorisk
list

En lista med taggar att ta bort.

Returer

Typ Description

Taggarna som lagras på körningsobjektet

restore_snapshot

Återställa en ögonblicksbild som en ZIP-fil. Returnerar sökvägen till ZIP.

restore_snapshot(snapshot_id=None, path=None)

Parametrar

Name Description
snapshot_id
str

Ögonblicksbilds-ID:t som ska återställas. Det senaste används om det inte anges.

standardvärde: None
path
str

Sökvägen där den nedladdade ZIP-filen sparas.

standardvärde: None

Returer

Typ Description
str

Sökvägen.

set_tags

Lägg till eller ändra en uppsättning taggar på körningen. Taggar som inte skickas i ordlistan lämnas orörda.

Du kan också lägga till enkla strängtaggar. När dessa taggar visas i taggordlistan som nycklar har de värdet Ingen. Mer information finns i Tagga och hitta körningar.

set_tags(tags)

Parametrar

Name Description
tags
Obligatorisk
dict[str] eller str

Taggarna som lagras i körningsobjektet.

start

Markera körningen som startad.

Detta används vanligtvis i avancerade scenarier när körningen har skapats av en annan aktör.

start()

submit_child

Skicka ett experiment och returnera den aktiva underordnade körningen.

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

Parametrar

Name Description
config
Obligatorisk
object

Konfigurationen som ska skickas.
tags
dict

Taggar som ska läggas till i den skickade körningen, t.ex. {"tag": "value"}.

standardvärde: None
kwargs
Obligatorisk
dict

Ytterligare parametrar som används i submit-funktionen för konfigurationer.

Returer

Typ Description
Run

Ett körningsobjekt.

Kommentarer

Submit är ett asynkront anrop till Azure Machine Learning-plattformen för att köra en utvärderingsversion av lokal maskinvara eller fjärrmaskinvara. Beroende på konfigurationen förbereder submit automatiskt körningsmiljöerna, kör koden och samlar in källkoden och resultaten i experimentets körningshistorik.

Om du vill skicka ett experiment måste du först skapa ett konfigurationsobjekt som beskriver hur experimentet ska köras. Konfigurationen beror på vilken typ av utvärderingsversion som krävs.

Ett exempel på hur du skickar ett underordnat experiment från din lokala dator med ScriptRunConfig är följande:


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

Mer information om hur du konfigurerar en körning finns i submit.

tag

Tagga körningen med en strängnyckel och ett valfritt strängvärde.

tag(key, value=None)

Parametrar

Name Description
key
Obligatorisk
str

Taggnyckeln
value
str

Ett valfritt värde för taggen

standardvärde: None

Kommentarer

Taggar och egenskaper på en körning är båda ordlistor för sträng –> sträng. Skillnaden mellan dem är föränderlighet: Taggar kan anges, uppdateras och tas bort medan egenskaper bara kan läggas till. Detta gör egenskaper mer lämpliga för system-/arbetsflödesrelaterade beteendeutlösare, medan taggar vanligtvis är användarriktade och meningsfulla för användarna av experimentet.


   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

Spara en ögonblicksbild av indatafilen eller mappen.

take_snapshot(file_or_folder_path)

Parametrar

Name Description
file_or_folder_path
Obligatorisk
str

Filen eller mappen som innehåller körningskällan.

Returer

Typ Description
str

Returnerar ögonblicksbilds-ID:t.

Kommentarer

Ögonblicksbilder är avsedda att vara den källkod som används för att köra experimentkörningen. Dessa lagras med körningen så att körningsutvärderingen kan replikeras i framtiden.

Anteckning

Ögonblicksbilder tas automatiskt när submit anropas. Vanligtvis krävs den här take_snapshot-metoden endast för interaktiva (notebook-körningar).

upload_file

Ladda upp en fil till körningsposten.

upload_file(name, path_or_stream, datastore_name=None)

Parametrar

Name Description
name
Obligatorisk
str

Namnet på filen som ska laddas upp.
path_or_stream
Obligatorisk
str

Den relativa lokala sökvägen eller strömmen till filen som ska laddas upp.
datastore_name
Obligatorisk
str

Valfritt DataStore-namn

Returer

Typ Description
ResourceProperties

Kommentarer


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

Anteckning

Kör automatiskt avbildningsfilen i den angivna utdatakatalogen, som standard är "./outputs" för de flesta körningstyper. Använd endast upload_file när ytterligare filer behöver laddas upp eller en utdatakatalog inte har angetts.

upload_files

Ladda upp filer till körningsposten.

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

Parametrar

Name Description
names
Obligatorisk
list

Namnen på de filer som ska laddas upp. Om det anges måste sökvägar också anges.
paths
Obligatorisk
list

De relativa lokala sökvägarna till de filer som ska laddas upp. Om det anges krävs namn.
return_artifacts
Obligatorisk
bool

Anger att ett artefaktobjekt ska returneras för varje fil som laddas upp.
timeout_seconds
Obligatorisk
int

Tidsgränsen för att ladda upp filer.
datastore_name
Obligatorisk
str

Valfritt DataStore-namn

Kommentarer

upload_files har samma effekt som upload_file för separata filer, men det finns prestanda- och resursanvändningsfördelar när du använder upload_files.


   import os

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

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

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

Anteckning

Kör automatiskt avbildningsfiler i den angivna utdatakatalogen, som som standard är "./outputs" för de flesta körningstyper. Använd endast upload_files när ytterligare filer behöver laddas upp eller en utdatakatalog inte har angetts.

upload_folder

Ladda upp den angivna mappen till det angivna prefixnamnet.

upload_folder(name, path, datastore_name=None)

Parametrar

Name Description
name
Obligatorisk
str

Namnet på mappen med filer som ska laddas upp.
folder
Obligatorisk
str

Den relativa lokala sökvägen till mappen som ska laddas upp.
datastore_name
Obligatorisk
str

Valfritt DataStore-namn

Kommentarer


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

Anteckning

Kör automatiskt avbildningsfiler i den angivna utdatakatalogen, som som standard är "./outputs" för de flesta körningstyper. Använd endast upload_folder när ytterligare filer behöver laddas upp eller en utdatakatalog inte har angetts.

wait_for_completion

Vänta tills körningen har slutförts. Returnerar statusobjektet efter väntetiden.

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

Parametrar

Name Description
show_output
bool

Anger om körningsutdata ska visas på sys.stdout.

standardvärde: False
wait_post_processing
bool

Anger om efterbearbetningen ska slutföras efter att körningen har slutförts.

standardvärde: False
raise_on_error
bool

Anger om ett fel utlöses när körningen är i ett feltillstånd.

standardvärde: True

Returer

Typ Description
dict

Statusobjektet.

Attribut

description

Returnera körningsbeskrivningen.

Den valfria beskrivningen av körningen är en användardefinerad sträng som är användbar för att beskriva en körning.

Returer

Typ Description
str

Körningsbeskrivningen.

display_name

Returnera körningsvisningsnamnet.

Det valfria visningsnamnet för körningen är en användardefinerad sträng som är användbar för senare identifiering av körningen.

Returer

Typ Description
str

Körningens visningsnamn.

experiment

Hämta experiment som innehåller körningen.

Returer

Typ Description
Experiment

Hämtar experimentet som motsvarar körningen.

id

Hämta körnings-ID.

Körningens ID är en identifierare som är unik för det innehållande experimentet.

Returer

Typ Description
str

Körnings-ID:t.

name

DEPRECATED. Använd display_name.

Det valfria namnet på körningen är en användarspecifik sträng som är användbar för senare identifiering av körningen.

Returer

Typ Description
str

Körnings-ID:t.

number

Hämta körningsnummer.

Ett monotont ökande tal som representerar ordningen på körningar i ett experiment.

Returer

Typ Description
int

Körningsnumret.

parent

Hämta den överordnade körningen för den här körningen från tjänsten.

Körningar kan ha en valfri överordnad, vilket resulterar i en potentiell trädhierarki med körningar. Om du vill logga mått till en överordnad log körning använder du metoden för det överordnade objektet, run.parent.log()till exempel .

Returer

Typ Description
Run

Den överordnade körningen, eller Ingen om en inte har angetts.

properties

Returnera de oföränderliga egenskaperna för den här körningen.

Returer

Typ Description
dict[str],
str

Körningens lokalt cachelagrade egenskaper.

Kommentarer

Egenskaperna omfattar oföränderlig systemgenererad information, till exempel varaktighet, körningsdatum, användare osv.

status

Returnera körningsobjektets status.

tags

Returnera uppsättningen med föränderliga taggar på den här körningen.

Returer

Typ Description
dict

Taggarna som lagras på körningsobjektet.

type

Hämta körningstyp.

Anger hur körningen skapades eller konfigurerades.

Returer

Typ Description
str

Körningstypen.