Run Klas

Definieert de basisklasse voor alle Azure Machine Learning experiment wordt uitgevoerd.

Een run vertegenwoordigt één proefversie van een experiment. Uitvoeringen worden gebruikt voor het bewaken van de asynchrone uitvoering van een proefversie, logboekgegevens en opslaguitvoer van de proefversie, en voor het analyseren van resultaten en toegang tot artefacten die zijn gegenereerd door de proefversie.

Run-objecten worden gemaakt wanneer u een script voor het trainen van een model in veel verschillende scenario's in Azure Machine Learning, waaronder HyperDrive-uitvoeringen, Pijplijn-uitvoeringen en AutoML-uitvoeringen. Er wordt ook een Run-object gemaakt wanneer u submit of met de klasse start_logging Experiment .

Als u aan de slag wilt met experimenten en runs, gaat u naar

Overname
azureml._run_impl.run_base._RunBase
Run

Constructor

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

Parameters

experiment
Experiment

Het bevattende experiment.

run_id
<xref:str>

De id voor de run.

outputs
<xref:str>

De uitvoer die moet worden bij te houden.

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

Alleen intern gebruik.

kwargs
<xref:dict>

Een woordenlijst met aanvullende configuratieparameters.

Opmerkingen

Een run vertegenwoordigt één proefversie van een experiment. Een Run-object wordt gebruikt voor het bewaken van de asynchrone uitvoering van een proefversie, logboekgegevens en opslaguitvoer van de proefversie, en voor het analyseren van resultaten en toegangsartefacten die door de proefversie worden gegenereerd.

Uitvoeren wordt in uw experimenteercode gebruikt om metrische gegevens en artefacten vast te maken in de Run History-service.

Uitvoeren wordt buiten uw experimenten gebruikt om de voortgang te bewaken en om de gegenereerde metrische gegevens en resultaten op te vragen en te analyseren.

De functionaliteit van Uitvoeren omvat:

  • Metrische gegevens en gegevens opslaan en ophalen

  • Bestanden uploaden en downloaden

  • Tags en de onderliggende hiërarchie gebruiken om eerdere runs eenvoudig op te zoeken

  • Opgeslagen modelbestanden registreren als een model dat kan worden operationeel gemaakt

  • Eigenschappen van een run opslaan, wijzigen en ophalen

  • De huidige run laden vanuit een externe omgeving met de get_context methode

  • Efficiënt momentopnamen maken van een bestand of map voor reproduceerbaarheid

Deze klasse werkt met de Experiment in de volgende scenario's:

  • Een uitvoering maken door code uit te voeren met submit

  • Een interactieve run maken in een notebook met behulp van start_logging

  • Metrische gegevens vastleggen en artefacten uploaden in uw experiment, zoals bij gebruik log

  • Metrische gegevens lezen en artefacten downloaden bij het analyseren van experimentele resultaten, zoals bij gebruik get_metrics

Als u een uitvoering wilt verzenden, maakt u een configuratieobject dat beschrijft hoe het experiment wordt uitgevoerd. Hier zijn voorbeelden van de verschillende configuratieobjecten die u kunt gebruiken:

De volgende metrische gegevens kunnen worden toegevoegd aan een run tijdens het trainen van een experiment.

  • Scalaire

    • Registreer een numerieke waarde of tekenreekswaarde in de run met de opgegeven naam met behulp van log . Als u een metrische gegevens in een run vastketent, zorgt u ervoor dat die metrische gegevens worden opgeslagen in de runrecord in het experiment. U kunt dezelfde metrische gegevens meerdere keren in een run in een logboek maken, waardoor het resultaat wordt beschouwd als een vector van die metrische gegevens.

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

  • Lijst

    • Registreer een lijst met waarden voor de run met de opgegeven naam met behulp van log_list .

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

  • Rij

    • Met log_row wordt een metriek gemaakt met meerdere kolommen, zoals beschreven in kwargs . Elke benoemde parameter genereert een kolom met de opgegeven waarde. log_row kan één keer worden aangeroepen om een willekeurige tuple te maken of meerdere keren in een lus om een volledige tabel te genereren.

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

  • Tabel

    • Registreer een woordenboekobject voor de run met de opgegeven naam met behulp van log_table .

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

  • Installatiekopie

    • Registreer een afbeelding in de record van de run. Gebruik log_image om een afbeeldingsbestand of een matplotlib-plot te koppelen aan de run. Deze afbeeldingen zijn zichtbaar en vergelijkbaar in de runrecord.

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

Methoden

add_properties

Onveranderbare eigenschappen toevoegen aan de run.

Tags en eigenschappen (beide dict[str, str]) verschillen in hun veranderlijkheid. Eigenschappen zijn onveranderbaar, zodat ze een permanente record maken voor controledoeleinden. Tags zijn veranderlijk. Zie Tag and find runs (Runs taggen en vinden) voor meer informatie over het werken met tags en eigenschappen.

add_type_provider

Extensibility hook for custom Run types stored in Run History(Extensibility hook voor aangepaste runtypen die zijn opgeslagen in de run history).

cancel

Markeer de run als geannuleerd.

Als er een taak is gekoppeld aan een cancel_uri veld, beëindigt u die taak ook.

child_run

Maak een onderliggende run.

clean

Verwijder de bestanden die overeenkomen met de huidige uitvoering op het doel dat is opgegeven in de uitvoeringsconfiguratie.

complete

Wacht tot de taakwachtrij is verwerkt.

Vervolgens wordt uitvoeren gemarkeerd als voltooid. Dit wordt doorgaans gebruikt in interactieve notebookscenario's.

create_children

Maak een of meer onderliggende runs.

download_file

Download een gekoppeld bestand uit de opslag.

download_files

Download bestanden van een bepaald opslag voorvoegsel (mapnaam) of de hele container als het voorvoegsel niet is opgegeven.

fail

Markeer de run als mislukt.

Stel eventueel de eigenschap Error van de run in met een bericht of uitzondering die is doorgegeven aan error_details .

flush

Wacht tot de taakwachtrij is verwerkt.

get

Haal de run voor deze werkruimte op met de run-id.

get_all_logs

Download alle logboeken voor de run naar een map.

get_children

Haal alle kinderen op voor de huidige run die is geselecteerd door opgegeven filters.

get_context

De huidige servicecontext retourneren.

Gebruik deze methode om de huidige servicecontext op te halen voor het vastleggen van metrische gegevens en het uploaden van bestanden. Als allow_offline waar is (de standaardinstelling), worden acties voor het object Uitvoeren afgedrukt om standaard uit te komen.

get_detailed_status

Haal de meest recente status van de run op. Als de status van de run 'In wachtrij' is, worden de details ervan weergeven.

get_details

Haal de definitie, statusinformatie, huidige logboekbestanden en andere details van de run op.

get_details_with_logs

De status van de run retourneren, inclusief de inhoud van het logboekbestand.

get_environment

Haal de omgevingsdefinitie op die door deze run is gebruikt.

get_file_names

Vermeld de bestanden die zijn opgeslagen in verband met de run.

get_metrics

Haal de metrische gegevens op die zijn geregistreerd bij de run.

Als waar is (standaard onwaar), haalt u metrische gegevens op voor runs in de recursive subtree van de opgegeven run.

get_properties

Haal de meest recente eigenschappen van de run op uit de service.

get_secret

Haal de geheime waarde op uit de context van een run.

Haal de geheime waarde op voor de opgegeven naam. De geheime naam verwijst naar een waarde die is opgeslagen in Azure Key Vault gekoppeld aan uw werkruimte. Zie Geheimen gebruiken in trainings runs voor een voorbeeld van het werken met geheimen.

get_secrets

Haal de geheime waarden op voor een bepaalde lijst met geheime namen.

Haal een woordenlijst met gevonden en niet gevonden geheimen op voor de lijst met opgegeven namen. Elke geheime naam verwijst naar een waarde die is opgeslagen in Azure Key Vault gekoppeld aan uw werkruimte. Zie Geheimen gebruiken in trainings runs voor een voorbeeld van het werken met geheimen.

get_snapshot_id

Haal de meest recente momentopname-id op.

get_status

Haal de meest recente status van de run op.

Veelvoorkomende waarden die worden geretourneerd, zijn 'Wordt uitgevoerd', 'Voltooid' en 'Mislukt'.

get_submitted_run

AFGEKEURD. Gebruik get_context.

Haal de ingediende run voor dit experiment op.

get_tags

Haal de meest recente set met veranderlijke tags op tijdens de run van de service.

list

Haal een lijst met runs op in een experiment dat is opgegeven door optionele filters.

list_by_compute

Haal een lijst met runs op in een berekening die is opgegeven door optionele filters.

log

Registreer een metrische waarde voor de run met de opgegeven naam.

log_accuracy_table

Registreer een nauwkeurigheidstabel in het artefactopslag.

De metrische gegevens van de nauwkeurigheidstabel zijn niet-scalaire metrische gegevens voor meerdere gebruiksmogelijkheden die kunnen worden gebruikt om meerdere soorten lijndiagrammen te produceren die continu variëren binnen de ruimte van voorspelde waarschijnlijkheden. Voorbeelden van deze grafieken zijn ROC, precision-recall en lift-curven.

De berekening van de nauwkeurigheidstabel is vergelijkbaar met de berekening van een ROC-curve. Een ROC-curve slaat echte positieve percentages en fout-positieven op bij veel verschillende waarschijnlijkheidsdrempels. De nauwkeurigheidstabel slaat het onbewerkte aantal echte positieven, fout-positieven, werkelijke negatieven en fout-negatieven op bij veel waarschijnlijkheidsdrempelwaarden.

Er worden twee methoden gebruikt voor het selecteren van drempelwaarden: 'waarschijnlijkheid' en 'percentiel'. Ze verschillen in de manier waarop ze een steekproef nemen van de ruimte van voorspelde waarschijnlijkheden.

Waarschijnlijkheidsdrempels zijn drempelwaarden met gelijkmatige ruimte tussen 0 en 1. Als NUM_POINTS 5 is, zijn de waarschijnlijkheidsdrempels [0,0, 0,25, 0,5, 0,75, 1,0].

Percentieldrempels worden verdeeld op basis van de distributie van voorspelde waarschijnlijkheden. Elke drempelwaarde komt overeen met het percentiel van de gegevens bij een waarschijnlijkheidsdrempel. Als de NUM_POINTS bijvoorbeeld 5 is, wordt de eerste drempelwaarde op het 0e percentiel, de tweede op het 25e percentiel, het derde op de 50e, en meer.

De waarschijnlijkheidstabellen en percentieltabellen zijn beide 3D-lijsten waarbij de eerste dimensie het klasselabel vertegenwoordigt, de tweede dimensie de steekproef bij één drempelwaarde vertegenwoordigt (schaalt met NUM_POINTS) en de derde dimensie altijd 4 waarden heeft: TP, FP, TN, FN en altijd in die volgorde.

De verwarringswaarden (TP, FP, TN, FN) worden berekend met de één vs rest-strategie. Zie de volgende koppeling voor meer informatie: https://en.wikipedia.org/wiki/Multiclass_classification

N = aantal voorbeelden in validatieset (voorbeeld 200) M = # drempelwaarden = # steekproeven afkomstig uit de waarschijnlijkheidsruimte (5 in voorbeeld) C = # klassen in volledige gegevensset (3 in voorbeeld)

Enkele invarianten van de nauwkeurigheidstabel:

  • TP + FP + TN + FN = N voor alle drempelwaarden voor alle klassen
  • TP + FN is hetzelfde bij alle drempelwaarden voor elke klasse
  • TN + FP is hetzelfde bij alle drempelwaarden voor elke klasse
  • Waarschijnlijkheidstabellen en percentieltabellen hebben vorm [C, M, 4]

Opmerking: M kan elke waarde zijn en bepaalt de resolutie van de grafieken Dit is onafhankelijk van de gegevensset, wordt gedefinieerd bij het berekenen van metrische gegevens en maakt een afweging tussen opslagruimte, rekentijd en resolutie.

Klasselabels moeten tekenreeksen zijn, verwarringswaarden moeten gehele getallen zijn en drempelwaarden moeten floats zijn.

log_confusion_matrix

Registreer een verwarringsmatrix bij de artefactopslag.

Hiermee wordt een wrapper rond de sklearn-verwarringsmatrix gelogd. De metrische gegevens bevatten de klasselabels en een 2D-lijst voor de matrix zelf. Zie de volgende koppeling voor meer informatie over hoe de metrische gegevens worden berekend: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html

log_image

Registreer een metrische gegevens van een afbeelding in de runrecord.

log_list

Registreer een lijst met metrische waarden voor de run met de opgegeven naam.

log_predictions

Registreer voorspellingen voor de artefactopslag.

Hiermee wordt een metrische score gelogd die kan worden gebruikt om de distributies van werkelijke doelwaarden te vergelijken met de verdeling van voorspelde waarden voor een regressietaak.

De voorspellingen zijn binned en standaardafwijkingen worden berekend voor foutbalken in een lijndiagram.

log_residuals

Residuen in het artefactopslaglogboek opslaan.

Hiermee registreert u de gegevens die nodig zijn om een histogram met residuen voor een regressietaak weer te geven. De residuen worden voorspeld - werkelijk.

Er moet één rand meer zijn dan het aantal tellingen. Raadpleeg de documentatie over het numpy-histogram voor voorbeelden van het gebruik van tellingen en randen om een histogram weer te geven. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html

log_row

Registreer een rij metriek voor de run met de opgegeven naam.

log_table

Registreer een tabel metriek voor de run met de opgegeven naam.

register_model

Een model registreren voor operationalisatie.

remove_tags

Verwijder de lijst met veranderlijke tags voor deze run.

restore_snapshot

Een momentopname herstellen als zip-bestand. Retourneert het pad naar het ZIP-bestand.

set_tags

Een set tags toevoegen of wijzigen tijdens de run. Tags die niet in de woordenlijst worden doorgegeven, blijven ongewijzigd.

U kunt ook eenvoudige tekenreekstags toevoegen. Wanneer deze tags als sleutels worden weergegeven in de tagwoordenlijst, hebben ze de waarde Geen. Zie Tag and find runs (Runs taggen en zoeken) voor meer informatie.

start

Markeer de run als gestart.

Dit wordt doorgaans gebruikt in geavanceerde scenario's waarin de run is gemaakt door een andere actor.

submit_child

Verzend een experiment en retourneer de actieve onderliggende run.

tag

Tag de run met een tekenreekssleutel en optionele tekenreekswaarde.

take_snapshot

Sla een momentopname van het invoerbestand of de invoermap op.

upload_file

Upload bestand toevoegen aan de runrecord.

upload_files

Upload bestanden toevoegen aan de run-record.

upload_folder

Upload opgegeven map aan de opgegeven voorvoegselnaam.

wait_for_completion

Wacht tot deze uitvoering is voltooid. Retourneert het statusobject na het wachten.

add_properties

Onveranderbare eigenschappen toevoegen aan de run.

Tags en eigenschappen (beide dict[str, str]) verschillen in hun veranderlijkheid. Eigenschappen zijn onveranderbaar, zodat ze een permanente record maken voor controledoeleinden. Tags zijn veranderlijk. Zie Tag and find runs (Runs taggen en vinden) voor meer informatie over het werken met tags en eigenschappen.

add_properties(properties)

Parameters

properties
<xref:dict>

De verborgen eigenschappen die zijn opgeslagen in het run-object.

add_type_provider

Extensibility hook for custom Run types stored in Run History(Extensibility hook voor aangepaste runtypen die zijn opgeslagen in de run history).

add_type_provider(runtype, run_factory)

Parameters

runtype
<xref:str>

De waarde van Run.type waarvoor de factory wordt aangeroepen. Voorbeelden zijn hyperdrive of azureml.scriptrun, maar kunnen worden uitgebreid met aangepaste typen.

run_factory
<xref:function>

Een functie met handtekening (Experiment, RunDto) - > Uitvoeren om te worden aangeroepen wanneer de lijst wordt uitgevoerd.

cancel

Markeer de run als geannuleerd.

Als er een taak is gekoppeld aan een cancel_uri veld, beëindigt u die taak ook.

cancel()

child_run

Maak een onderliggende run.

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

Parameters

name
<xref:str>
standaardwaarde: None

Een optionele naam voor de onderliggende run, doorgaans opgegeven voor een 'onderdeel'.

run_id
<xref:str>
standaardwaarde: None

Een optionele run-id voor het onderliggende, anders wordt deze automatisch gegenereerd. Deze parameter is doorgaans niet ingesteld.

outputs
<xref:str>
standaardwaarde: None

Optionele uitvoermap voor het onderliggende bestand.

Retouren

De onderliggende run.

Retourtype

Run

Opmerkingen

Dit wordt gebruikt om een deel van een run te isoleren in een subsectie. Dit kan worden gedaan voor identificeerbare 'onderdelen' van een run die interessant zijn om te scheiden, of om onafhankelijke metrische gegevens vast te leggen voor een interatie van een subproces.

Als er een uitvoermap is ingesteld voor de onderliggende run, wordt de inhoud van die map geüpload naar de onderliggende runrecord wanneer het onderliggende bestand is voltooid.

clean

Verwijder de bestanden die overeenkomen met de huidige uitvoering op het doel dat is opgegeven in de uitvoeringsconfiguratie.

clean()

Retouren

Een lijst met verwijderde bestanden.

Retourtype

complete

Wacht tot de taakwachtrij is verwerkt.

Vervolgens wordt uitvoeren gemarkeerd als voltooid. Dit wordt doorgaans gebruikt in interactieve notebookscenario's.

complete(_set_status=True)

Parameters

_set_status
<xref:bool>
standaardwaarde: True

Geeft aan of de statusgebeurtenis voor tracering moet worden verzenden.

create_children

Maak een of meer onderliggende runs.

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

Parameters

count
<xref:int>
standaardwaarde: None

Een optioneel aantal te maken kinderen.

tag_key
<xref:str>
standaardwaarde: None

Een optionele sleutel voor het vullen van de vermelding Tags in alle gemaakte kinderen.

tag_Values
standaardwaarde: None

Een optionele lijst met waarden die worden toe te voegen aan Tags[tag_key] voor de lijst met gemaakte runs.

Retouren

De lijst met onderliggende runs.

Retourtype

Opmerkingen

Parameter count OR parameters tag_key AND moet worden tag_values opgegeven.

download_file

Download een gekoppeld bestand uit de opslag.

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

Parameters

name
<xref:str>

De naam van het artefact dat moet worden gedownload.

output_file_path
<xref:str>

Het lokale pad waar het artefact moet worden opgeslagen.

download_files

Download bestanden van een bepaald opslag voorvoegsel (mapnaam) of de hele container als het voorvoegsel niet is opgegeven.

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

Parameters

prefix
<xref:str>

Het bestandspadvoorvoegsel in de container van waaruit alle artefacten moeten worden gedownload.

output_directory
<xref:str>

Een optionele map die door alle artefactpaden als voorvoegsel wordt gebruikt.

output_paths
[<xref:str>]

Optionele bestandspaden waarin de gedownloade artefacten worden opgeslagen. Moet uniek zijn en overeenkomen met de lengte van paden.

batch_size
<xref:int>

Het aantal bestanden dat per batch moet worden gedownload. De standaardwaarde is 100 bestanden.

append_prefix
<xref:bool>

Een optionele vlag voor het toevoegen van het opgegeven voorvoegsel van het uiteindelijke uitvoerbestandspad. Als false is, wordt het voorvoegsel verwijderd uit het uitvoerbestandspad.

fail

Markeer de run als mislukt.

Stel eventueel de eigenschap Error van de run in met een bericht of uitzondering die is doorgegeven aan error_details .

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

Parameters

error_details
<xref:str> of <xref:BaseException>
standaardwaarde: None

Optionele details van de fout.

error_code
<xref:str>
standaardwaarde: None

Optionele foutcode van de fout voor de foutclassificatie.

_set_status
<xref:bool>
standaardwaarde: True

Geeft aan of de statusgebeurtenis voor tracering moet worden verzenden.

flush

Wacht tot de taakwachtrij is verwerkt.

flush(timeout_seconds=300)

Parameters

timeout_seconds
<xref:int>
standaardwaarde: 300

Hoe lang moet worden gewacht (in seconden) tot de taakwachtrij is verwerkt.

get

Haal de run voor deze werkruimte op met de run-id.

get(workspace, run_id)

Parameters

workspace
Workspace

De bevattende werkruimte.

run_id
string

De run-id.

Retouren

De verzonden run.

Retourtype

Run

get_all_logs

Download alle logboeken voor de run naar een map.

get_all_logs(destination=None)

Parameters

destination
<xref:str>
standaardwaarde: None

Het doelpad voor het opslaan van logboeken. Als dit niet is gespecificeerd, wordt er een map met de naam van de run-id gemaakt in de projectmap.

Retouren

Een lijst met namen van gedownloade logboeken.

Retourtype

get_children

Haal alle kinderen op voor de huidige run die is geselecteerd door opgegeven filters.

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

Parameters

recursive
<xref:bool>
standaardwaarde: False

Geeft aan of alle aten moeten worden doorstaan.

tags
<xref:str> of <xref:dict>
standaardwaarde: None

Indien opgegeven, retourneert runs die overeenkomen met de opgegeven "tag" of {"tag": "value"}.

properties
<xref:str> of <xref:dict>
standaardwaarde: None

Indien opgegeven, retourneert runs die overeenkomen met de opgegeven eigenschap of {"property": "value"}.

type
<xref:str>
standaardwaarde: None

Indien opgegeven, retourneert runs die overeenkomen met dit type.

status
<xref:str>
standaardwaarde: None

Indien opgegeven, retourneert runs met status opgegeven "status".

_rehydrate_runs
<xref:bool>
standaardwaarde: True

Geeft aan of een instantie moet worden uitgevoerd van het oorspronkelijke type of van de basisrun.

Retouren

Een lijst met Run objecten.

Retourtype

get_context

De huidige servicecontext retourneren.

Gebruik deze methode om de huidige servicecontext op te halen voor het vastleggen van metrische gegevens en het uploaden van bestanden. Als allow_offline waar is (de standaardinstelling), worden acties voor het object Uitvoeren afgedrukt om standaard uit te komen.

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

Parameters

cls

Geeft de klassemethode aan.

allow_offline
<xref:bool>
standaardwaarde: True

Laat de servicecontext terugvallen op de offlinemodus, zodat het trainingsscript lokaal kan worden getest zonder een taak te verzenden met de SDK. Standaard true.

kwargs
<xref:dict>
standaardwaarde: False

Een woordenlijst met aanvullende parameters.

Retouren

De verzonden run.

Retourtype

Run

Opmerkingen

Deze functie wordt vaak gebruikt om het geverifieerde Run-object op te halen in een script dat moet worden verzonden voor uitvoering via experiment.submit(). Dit run-object is zowel een geverifieerde context om te communiceren met Azure Machine Learning-services als een conceptuele container waarin metrische gegevens, bestanden (artefacten) en modellen zijn opgenomen.


   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

Haal de meest recente status van de run op. Als de status van de run 'In wachtrij' is, worden de details ervan weergeven.

get_detailed_status()

Retouren

De meest recente status en details

Retourtype

<xref:dict>[<xref:str>, <xref:str>]

Opmerkingen

  • status: de huidige status van de run. Dezelfde waarde als die is geretourneerd door get_status().

  • details: de gedetailleerde informatie voor de huidige 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

Haal de definitie, statusinformatie, huidige logboekbestanden en andere details van de run op.

get_details()

Retouren

De details voor de run retourneren

Retourtype

<xref:dict>[<xref:str>, <xref:str>]

Opmerkingen

De geretourneerde woordenlijst bevat de volgende sleutel-waardeparen:

  • runId: id van deze run.

  • Doel

  • status: de huidige status van de run. Dezelfde waarde als die is geretourneerd door get_status().

  • startTimeUtc: UTC-tijd waarop deze run is gestart, in ISO8601.

  • endTimeUtc: UTC-tijd waarop deze run is voltooid (voltooid of mislukt), in ISO8601.

    Deze sleutel bestaat niet als de uitvoering nog wordt uitgevoerd.

  • properties: onveranderbare sleutel-waardeparen die zijn gekoppeld aan de run. De standaardeigenschappen omvatten de momentopname-id van de run en informatie over de Git-opslagplaats van waaruit de run is gemaakt (indien vandaan). Aanvullende eigenschappen kunnen worden toegevoegd aan een run met behulp van add_properties .

  • inputDatasets: invoergegevenssets die zijn gekoppeld aan de run.

  • outputDatasets: uitvoergegevenssets die zijn gekoppeld aan de run.

  • Logbestanden

  • 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

De status van de run retourneren, inclusief de inhoud van het logboekbestand.

get_details_with_logs()

Retouren

Retourneert de status voor de run met inhoud van het logboekbestand.

Retourtype

<xref:dict>

get_environment

Haal de omgevingsdefinitie op die door deze run is gebruikt.

get_environment()

Retouren

Het omgevingsobject retourneren.

Retourtype

get_file_names

Vermeld de bestanden die zijn opgeslagen in verband met de run.

get_file_names()

Retouren

De lijst met paden voor bestaande artefacten

Retourtype

list[<xref:str>]

get_metrics

Haal de metrische gegevens op die zijn geregistreerd bij de run.

Als waar is (standaard onwaar), haalt u metrische gegevens op voor runs in de recursive subtree van de opgegeven run.

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

Parameters

name
<xref:str>
standaardwaarde: None

De naam van de metrische gegevens.

recursive
<xref:bool>
standaardwaarde: False

Geeft aan of alle aten moeten worden doorstaan.

run_type
<xref:str>
standaardwaarde: None
populate
<xref:bool>
standaardwaarde: False

Geeft aan of de inhoud van externe gegevens die aan de metrische gegevens zijn gekoppeld, moet worden opgehaald.

Retouren

Een woordenlijst met de metrische gegevens van gebruikers.

Retourtype

<xref:dict>

Opmerkingen


   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

Haal de meest recente eigenschappen van de run op uit de service.

get_properties()

Retouren

De eigenschappen van de run.

Retourtype

<xref:dict>

Opmerkingen

Eigenschappen zijn onveranderbare door het systeem gegenereerde informatie, zoals duur, uitvoeringsdatum, gebruiker en aangepaste eigenschappen die zijn toegevoegd met de add_properties methode . Zie Tag and find runs (Runs taggen en vinden) voor meer informatie.

Wanneer u een taak indient naar Azure Machine Learning, als bronbestanden worden opgeslagen in een lokale Git-opslagplaats, wordt informatie over de opslagplaats opgeslagen als eigenschappen. Deze git-eigenschappen worden toegevoegd bij het maken van een run of het aanroepen van Experiment.submit. Zie Git-integratie voor meer informatie over git-eigenschappen Azure Machine Learning.

get_secret

Haal de geheime waarde op uit de context van een run.

Haal de geheime waarde op voor de opgegeven naam. De geheime naam verwijst naar een waarde die is opgeslagen in Azure Key Vault gekoppeld aan uw werkruimte. Zie Geheimen gebruiken in trainings runs voor een voorbeeld van het werken met geheimen.

get_secret(name)

Parameters

name
<xref:str>

De geheime naam waarvoor een geheim moet worden retourneren.

Retouren

De geheime waarde.

Retourtype

<xref:str>

get_secrets

Haal de geheime waarden op voor een bepaalde lijst met geheime namen.

Haal een woordenlijst met gevonden en niet gevonden geheimen op voor de lijst met opgegeven namen. Elke geheime naam verwijst naar een waarde die is opgeslagen in Azure Key Vault gekoppeld aan uw werkruimte. Zie Geheimen gebruiken in trainings runs voor een voorbeeld van het werken met geheimen.

get_secrets(secrets)

Parameters

secrets
list[<xref:str>]

Een lijst met geheime namen waarvoor geheime waarden moeten worden retourneert.

Retouren

Retourneert een woordenlijst met gevonden en niet gevonden geheimen.

Retourtype

<xref:dict>[<xref:str: str>]

get_snapshot_id

Haal de meest recente momentopname-id op.

get_snapshot_id()

Retouren

De meest recente momentopname-id.

Retourtype

<xref:str>

get_status

Haal de meest recente status van de run op.

Veelvoorkomende waarden die worden geretourneerd, zijn 'Wordt uitgevoerd', 'Voltooid' en 'Mislukt'.

get_status()

Retouren

De meest recente status.

Retourtype

<xref:str>

Opmerkingen

  • NotStarted: dit is een tijdelijke status aan de clientzijde Run objects are in before cloud submission.

  • Starten: de run wordt verwerkt in de cloud. De aanroeper heeft op dit moment een run-id.

  • Inrichting: wordt geretourneerd wanneer rekenkracht op aanvraag wordt gemaakt voor het indienen van een bepaalde taak.

  • Voorbereiden: de run-omgeving wordt voorbereid:

    • docker image build

    • conda-omgeving instellen

  • In wachtrij: de taak wordt in de wachtrij geplaatst in het rekendoel. In BatchAI heeft de taak bijvoorbeeld de status In de wachtrij

    terwijl u wacht totdat alle aangevraagde knooppunten gereed zijn.

  • Uitvoeren: de taak is gestart om te worden uitgevoerd in het rekendoel.

  • Finalizing: de gebruikerscode is voltooid en de run wordt uitgevoerd in de naverwerkingsfasen.

  • CancelRequested: annulering is aangevraagd voor de taak.

  • Voltooid: de run is voltooid. Dit omvat zowel de gebruikerscode als de run

    naverwerkingsfasen.

  • Mislukt: de run is mislukt. Normaal gesproken geeft de eigenschap Fout bij een run details over de reden.

  • Geannuleerd: volgt een annuleringsaanvraag en geeft aan dat de run nu is geannuleerd.

  • NotResponding: voor runs met heartbeats is er onlangs geen heartbeat verzonden.


   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

AFGEKEURD. Gebruik get_context.

Haal de ingediende run voor dit experiment op.

get_submitted_run(**kwargs)

Parameters

cls

Retouren

De verzonden run.

Retourtype

Run

get_tags

Haal de meest recente set met veranderlijke tags op tijdens de run van de service.

get_tags()

Retouren

De tags die zijn opgeslagen op het run-object.

Retourtype

<xref:dict>

list

Haal een lijst met runs op in een experiment dat is opgegeven door optionele filters.

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

Parameters

experiment
Experiment

Het bevattende experiment.

type
<xref:str>
standaardwaarde: None

Indien opgegeven, retourneert runs die overeenkomen met het opgegeven type.

tags
<xref:str> of <xref:dict>
standaardwaarde: None

Indien opgegeven, retourneert runs die overeenkomen met de opgegeven "tag" of {"tag": "value"}.

properties
<xref:str> of <xref:dict>
standaardwaarde: None

Indien opgegeven, retourneert runs die overeenkomen met de opgegeven eigenschap of {"eigenschap": "value"}.

status
<xref:str>
standaardwaarde: None

Indien opgegeven, retourneert runs met de status opgegeven "status".

include_children
<xref:bool>
standaardwaarde: False

Als deze is ingesteld op true, haalt u alle runs op, niet alleen die op het hoogste niveau.

_rehydrate_runs
<xref:bool>
standaardwaarde: True

Als deze optie is ingesteld op True (standaard), wordt de geregistreerde provider gebruikt om een object voor dat type opnieuw te maken in plaats van de basisuitvoer.

Retouren

Een lijst met runs.

Retourtype

Opmerkingen

In het volgende codevoorbeeld ziet u een aantal gebruiksvoorbeelden van de list methode .


   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

Haal een lijst met runs op in een berekening die is opgegeven door optionele filters.

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

Parameters

compute
ComputeTarget

De met rekenkracht.

type
<xref:str>
standaardwaarde: None

Indien opgegeven, retourneert runs die overeenkomen met het opgegeven type.

tags
<xref:str> of <xref:dict>
standaardwaarde: None

Indien opgegeven, retourneert runs die overeenkomen met de opgegeven "tag" of {"tag": "value"}.

properties
<xref:str> of <xref:dict>
standaardwaarde: None

Indien opgegeven, retourneert runs die overeenkomen met de opgegeven eigenschap of {"eigenschap": "value"}.

status
<xref:str>
standaardwaarde: None

Indien opgegeven, retourneert runs met de status opgegeven "status". Alleen toegestane waarden zijn 'Running' en 'Queued'.

Retouren

een generator van ~_restclient.models.RunDto

Retourtype

<xref:builtin.generator>

log

Registreer een metrische waarde voor de run met de opgegeven naam.

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

Parameters

name
<xref:str>

De naam van het metrische gegeven.

value

De waarde die in de service moet worden geplaatst.

description
<xref:str>

Een optionele beschrijving van metrische gegevens.

step
<xref:int>
standaardwaarde: None

Een optionele as om de waardeorder binnen een metrische waarde op te geven.

Opmerkingen

Het vastleggen van metrische gegevens in een run zorgt ervoor dat de metrische gegevens worden opgeslagen in de runrecord in het experiment. U kunt dezelfde metrische gegevens meerdere keren in een run in een logboek maken, waardoor het resultaat wordt beschouwd als een vector van die metrische gegevens. Als stap is opgegeven voor een metrische waarde, moet deze worden opgegeven voor alle waarden.

log_accuracy_table

Registreer een nauwkeurigheidstabel in het artefactopslag.

De metrische gegevens van de nauwkeurigheidstabel zijn niet-scalaire metrische gegevens voor meerdere gebruiksmogelijkheden die kunnen worden gebruikt om meerdere soorten lijndiagrammen te produceren die continu variëren binnen de ruimte van voorspelde waarschijnlijkheden. Voorbeelden van deze grafieken zijn ROC, precision-recall en lift-curven.

De berekening van de nauwkeurigheidstabel is vergelijkbaar met de berekening van een ROC-curve. Een ROC-curve slaat echte positieve percentages en fout-positieven op bij veel verschillende waarschijnlijkheidsdrempels. De nauwkeurigheidstabel slaat het onbewerkte aantal echte positieven, fout-positieven, werkelijke negatieven en fout-negatieven op bij veel waarschijnlijkheidsdrempelwaarden.

Er worden twee methoden gebruikt voor het selecteren van drempelwaarden: 'waarschijnlijkheid' en 'percentiel'. Ze verschillen in de manier waarop ze een steekproef nemen van de ruimte van voorspelde waarschijnlijkheden.

Waarschijnlijkheidsdrempels zijn drempelwaarden met gelijkmatige ruimte tussen 0 en 1. Als NUM_POINTS 5 is, zijn de waarschijnlijkheidsdrempels [0,0, 0,25, 0,5, 0,75, 1,0].

Percentieldrempels worden verdeeld op basis van de distributie van voorspelde waarschijnlijkheden. Elke drempelwaarde komt overeen met het percentiel van de gegevens bij een waarschijnlijkheidsdrempel. Als de NUM_POINTS bijvoorbeeld 5 is, wordt de eerste drempelwaarde op het 0e percentiel, de tweede op het 25e percentiel, het derde op de 50e, en meer.

De waarschijnlijkheidstabellen en percentieltabellen zijn beide 3D-lijsten waarbij de eerste dimensie het klasselabel vertegenwoordigt, de tweede dimensie de steekproef bij één drempelwaarde vertegenwoordigt (schaalt met NUM_POINTS) en de derde dimensie altijd 4 waarden heeft: TP, FP, TN, FN en altijd in die volgorde.

De verwarringswaarden (TP, FP, TN, FN) worden berekend met de één vs rest-strategie. Zie de volgende koppeling voor meer informatie: https://en.wikipedia.org/wiki/Multiclass_classification

N = aantal voorbeelden in validatieset (voorbeeld 200) M = # drempelwaarden = # steekproeven afkomstig uit de waarschijnlijkheidsruimte (5 in voorbeeld) C = # klassen in volledige gegevensset (3 in voorbeeld)

Enkele invarianten van de nauwkeurigheidstabel:

  • TP + FP + TN + FN = N voor alle drempelwaarden voor alle klassen
  • TP + FN is hetzelfde bij alle drempelwaarden voor elke klasse
  • TN + FP is hetzelfde bij alle drempelwaarden voor elke klasse
  • Waarschijnlijkheidstabellen en percentieltabellen hebben vorm [C, M, 4]

Opmerking: M kan elke waarde zijn en bepaalt de resolutie van de grafieken Dit is onafhankelijk van de gegevensset, wordt gedefinieerd bij het berekenen van metrische gegevens en maakt een afweging tussen opslagruimte, rekentijd en resolutie.

Klasselabels moeten tekenreeksen zijn, verwarringswaarden moeten gehele getallen zijn en drempelwaarden moeten floats zijn.

log_accuracy_table(name, value, description='')

Parameters

name
<xref:str>

De naam van de nauwkeurigheidstabel.

value
<xref:str> of <xref:dict>

JSON met naam-, versie- en gegevenseigenschappen.

description
<xref:str>

Een optionele beschrijving van metrische gegevens.

Opmerkingen

Voorbeeld van een geldige JSON-waarde:


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

Registreer een verwarringsmatrix bij de artefactopslag.

Hiermee wordt een wrapper rond de sklearn-verwarringsmatrix gelogd. De metrische gegevens bevatten de klasselabels en een 2D-lijst voor de matrix zelf. Zie de volgende koppeling voor meer informatie over hoe de metrische gegevens worden berekend: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html

log_confusion_matrix(name, value, description='')

Parameters

name
<xref:str>

De naam van de verwarringsmatrix.

value
<xref:str> of <xref:dict>

JSON met naam-, versie- en gegevenseigenschappen.

description
<xref:str>

Een optionele beschrijving van metrische gegevens.

Opmerkingen

Voorbeeld van een geldige JSON-waarde:


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

Registreer een metrische gegevens van een afbeelding in de runrecord.

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

Parameters

name
<xref:str>

De naam van de metrische gegevens.

path
<xref:str>

Het pad of de stroom van de afbeelding.

plot
<xref:matplotlib.pyplot>

De plot die als afbeelding moet worden gelogd.

description
<xref:str>

Een optionele beschrijving van metrische gegevens.

Opmerkingen

Gebruik deze methode om een afbeeldingsbestand of een matplotlib-plot bij de run te leggen. Deze afbeeldingen zijn zichtbaar en vergelijkbaar in de runrecord.

log_list

Registreer een lijst met metrische waarden voor de run met de opgegeven naam.

log_list(name, value, description='')

Parameters

name
<xref:str>

De naam van het metrische gegeven.

value
list

De waarden van de metrische waarde.

description
<xref:str>

Een optionele beschrijving van metrische gegevens.

log_predictions

Registreer voorspellingen voor de artefactopslag.

Hiermee wordt een metrische score gelogd die kan worden gebruikt om de distributies van werkelijke doelwaarden te vergelijken met de verdeling van voorspelde waarden voor een regressietaak.

De voorspellingen zijn binned en standaardafwijkingen worden berekend voor foutbalken in een lijndiagram.

log_predictions(name, value, description='')

Parameters

name
<xref:str>

De naam van de voorspellingen.

value
<xref:str> of <xref:dict>

JSON met naam-, versie- en gegevenseigenschappen.

description
<xref:str>

Een optionele beschrijving van metrische gegevens.

Opmerkingen

Voorbeeld van een geldige JSON-waarde:


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

Residuen in het artefactopslaglogboek opslaan.

Hiermee registreert u de gegevens die nodig zijn om een histogram met residuen voor een regressietaak weer te geven. De residuen worden voorspeld - werkelijk.

Er moet één rand meer zijn dan het aantal tellingen. Raadpleeg de documentatie over het numpy-histogram voor voorbeelden van het gebruik van tellingen en randen om een histogram weer te geven. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html

log_residuals(name, value, description='')

Parameters

name
<xref:str>

De naam van de residuen.

value
<xref:str> of <xref:dict>

JSON met naam-, versie- en gegevenseigenschappen.

description
<xref:str>

Een optionele beschrijving van metrische gegevens.

Opmerkingen

Voorbeeld van een geldige JSON-waarde:


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

Registreer een rij metriek voor de run met de opgegeven naam.

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

Parameters

name
<xref:str>

De naam van het metrische gegeven.

description
<xref:str>
standaardwaarde: None

Een optionele beschrijving van metrische gegevens.

kwargs
<xref:dict>

Een woordenlijst met aanvullende parameters. In dit geval de kolommen van de metrische gegevens.

Opmerkingen

Met log_row wordt een tabel metriek gemaakt met kolommen zoals beschreven in kwargs. Elke benoemde parameter genereert een kolom met de opgegeven waarde. log_row kan één keer worden aangeroepen om een willekeurige tuple of meerdere keren in een lus aan te melden om een volledige tabel te genereren.


   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

Registreer een tabel metriek voor de run met de opgegeven naam.

log_table(name, value, description='')

Parameters

name
<xref:str>

De naam van het metrische gegeven.

value
<xref:dict>

De tabelwaarde van de metrische waarde, een woordenlijst waarin sleutels kolommen zijn die in de service moeten worden geplaatst.

description
<xref:str>

Een optionele beschrijving van metrische gegevens.

register_model

Een model registreren voor operationalisatie.

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)

Parameters

model_name
<xref:str>

De naam van het model.

model_path
<xref:str>
standaardwaarde: None

Het relatieve cloudpad naar het model, bijvoorbeeld 'outputs/modelname'. Wanneer niet opgegeven (Geen), model_name wordt gebruikt als het pad.

tags
<xref:dict>[<xref:str>, <xref:str>]
standaardwaarde: None

Een woordenlijst met sleutelwaardetags die moeten worden toegewezen aan het model.

properties
<xref:dict>[<xref:str>, <xref:str>]
standaardwaarde: None

Een woordenlijst met sleutelwaarde-eigenschappen die aan het model moeten worden toegewezen. Deze eigenschappen kunnen niet worden gewijzigd na het maken van het model, maar er kunnen nieuwe sleutel-waardeparen worden toegevoegd.

model_framework
<xref:str>
standaardwaarde: None

Het framework van het model dat moet worden geregistreerd. Momenteel ondersteunde frameworks: TensorFlow, ScikitLearn, Onnx, Custom, Multi

model_framework_version
<xref:str>
standaardwaarde: None

De frameworkversie van het geregistreerde model.

description
<xref:str>
standaardwaarde: None

Een optionele beschrijving van het model.

datasets
list[(<xref:str>, AbstractDataset)]
standaardwaarde: None

Een lijst met tuples waarbij het eerste element de relatie tussen gegevensset en model beschrijft en het tweede element de gegevensset is.

sample_input_dataset
AbstractDataset
standaardwaarde: None

Optioneel. Voorbeeldinvoergegevensset voor het geregistreerde model

sample_output_dataset
AbstractDataset
standaardwaarde: None

Optioneel. Voorbeelduitvoergegevensset voor het geregistreerde model

resource_configuration
ResourceConfiguration
standaardwaarde: None

Optioneel. Resourceconfiguratie voor het uitvoeren van het geregistreerde model

kwargs
<xref:dict>

Optionele parameters.

Retouren

Het geregistreerde model.

Retourtype

Opmerkingen


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

remove_tags

Verwijder de lijst met veranderlijke tags voor deze run.

remove_tags(tags)

Parameters

tags
list

Een lijst met tags die moeten worden verwijderd.

Retouren

De tags die zijn opgeslagen op het run-object

restore_snapshot

Een momentopname herstellen als zip-bestand. Retourneert het pad naar het ZIP-bestand.

restore_snapshot(snapshot_id=None, path=None)

Parameters

snapshot_id
<xref:str>
standaardwaarde: None

De momentopname-id die moet worden hersteld. De meest recente wordt gebruikt als deze niet is opgegeven.

path
<xref:str>
standaardwaarde: None

Het pad waar het gedownloade ZIP-bestand wordt opgeslagen.

Retouren

Het pad.

Retourtype

<xref:str>

set_tags

Een set tags toevoegen of wijzigen tijdens de run. Tags die niet in de woordenlijst worden doorgegeven, blijven ongewijzigd.

U kunt ook eenvoudige tekenreekstags toevoegen. Wanneer deze tags als sleutels worden weergegeven in de tagwoordenlijst, hebben ze de waarde Geen. Zie Tag and find runs (Runs taggen en zoeken) voor meer informatie.

set_tags(tags)

Parameters

tags
<xref:dict>[<xref:str>] of <xref:str>

De tags die zijn opgeslagen in het run-object.

start

Markeer de run als gestart.

Dit wordt doorgaans gebruikt in geavanceerde scenario's waarin de run is gemaakt door een andere actor.

start()

submit_child

Verzend een experiment en retourneer de actieve onderliggende run.

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

Parameters

config
<xref:object>

De configuratie die moet worden verzonden.

tags
<xref:dict>
standaardwaarde: None

Tags die moeten worden toegevoegd aan de verzonden run, bijvoorbeeld {"tag": "value"}.

kwargs
<xref:dict>

Aanvullende parameters die worden gebruikt voor de verzendfunctie voor configuraties.

Retouren

Een run-object.

Retourtype

Run

Opmerkingen

Verzenden is een asynchrone aanroep naar het Azure Machine Learning platform om een proefversie uit te voeren op lokale of externe hardware. Afhankelijk van de configuratie bereidt submit uw uitvoeringsomgevingen automatisch voor, voert u uw code uit en legt u uw broncode en resultaten vast in de uitvoeringsgeschiedenis van het experiment.

Als u een experiment wilt verzenden, moet u eerst een configuratieobject maken dat beschrijft hoe het experiment moet worden uitgevoerd. De configuratie is afhankelijk van het type proefversie dat is vereist.

Een voorbeeld van het verzenden van een onderliggend experiment vanaf uw lokale computer met ScriptRunConfig behulp van is als volgt:


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

Zie voor meer informatie over het configureren van een submit run.

tag

Tag de run met een tekenreekssleutel en optionele tekenreekswaarde.

tag(key, value=None)

Parameters

key
<xref:str>

De tagsleutel

value
<xref:str>
standaardwaarde: None

Een optionele waarde voor de tag

Opmerkingen

Tags en eigenschappen van een run zijn beide woordenlijsten van tekenreeks -> tekenreeks. Het verschil tussen deze twee is veranderbaarheid: Tags kunnen worden ingesteld, bijgewerkt en verwijderd, terwijl Eigenschappen alleen kunnen worden toegevoegd. Dit maakt Eigenschappen geschikter voor systeem-/werkstroomgerelateerde gedragstriggers, terwijl Tags over het algemeen gebruikersvriendelijk en zinvol zijn voor de gebruikers van het experiment.


   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

Sla een momentopname van het invoerbestand of de invoermap op.

take_snapshot(file_or_folder_path)

Parameters

file_or_folder_path
<xref:str>

Het bestand of de map met de broncode van de run.

Retouren

Retourneert de momentopname-id.

Retourtype

<xref:str>

Opmerkingen

Momentopnamen zijn bedoeld als de broncode die wordt gebruikt om de experimentrun uit te voeren. Deze worden samen met de run opgeslagen, zodat de proefversie van de run in de toekomst kan worden gerepliceerd.

Notitie

Momentopnamen worden automatisch gemaakt wanneer submit wordt aangeroepen. Normaal gesproken is de take_snapshot-methode alleen vereist voor interactieve (notebook)-runs.

upload_file

Upload bestand toevoegen aan de runrecord.

upload_file(name, path_or_stream, datastore_name=None)

Parameters

name
<xref:str>

De naam van het bestand dat moet worden geüpload.

path_or_stream
<xref:str>

Het relatieve lokale pad of de stream naar het bestand dat moet worden geüpload.

datastore_name
<xref:str>

Optionele naam van gegevensstore

Retourtype

Opmerkingen


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

Notitie

Voert automatisch vastleggen bestand in de opgegeven uitvoermap, die standaard ingesteld op "./outputs" voor de meeste runtypen. Gebruik upload_file alleen wanneer extra bestanden moeten worden geüpload of als er geen uitvoermap is opgegeven.

upload_files

Upload bestanden toevoegen aan de run-record.

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

Parameters

names
list

De namen van de bestanden die moeten worden geüpload. Indien ingesteld, moeten paden ook worden ingesteld.

paths
list

De relatieve lokale paden naar de bestanden die moeten worden geüpload. Als dit is ingesteld, zijn namen vereist.

return_artifacts
<xref:bool>

Geeft aan dat een artefactobject moet worden geretourneerd voor elk geüpload bestand.

timeout_seconds
<xref:int>

De time-out voor het uploaden van bestanden.

datastore_name
<xref:str>

Optionele naam van gegevensstore

Opmerkingen

upload_files heeft hetzelfde effect als op afzonderlijke bestanden, maar er zijn voordelen voor prestaties en upload_file resourcegebruik wanneer u upload_files gebruikt.


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

Notitie

Voert automatisch vastleggen van bestanden in de opgegeven uitvoermap, die standaard ingesteld op "./outputs" voor de meeste runtypen. Gebruik upload_files alleen wanneer extra bestanden moeten worden geüpload of als er geen uitvoermap is opgegeven.

upload_folder

Upload opgegeven map aan de opgegeven voorvoegselnaam.

upload_folder(name, path, datastore_name=None)

Parameters

name
<xref:str>

De naam van de map met bestanden die moeten worden geüpload.

folder
<xref:str>

Het relatieve lokale pad naar de map die moet worden geüpload.

datastore_name
<xref:str>

Optionele naam van gegevensstore

Opmerkingen


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

Notitie

Voert automatisch vastleggen van bestanden in de opgegeven uitvoermap, die standaard ingesteld op "./outputs" voor de meeste runtypen. Gebruik upload_folder alleen wanneer extra bestanden moeten worden geüpload of als er geen uitvoermap is opgegeven.

wait_for_completion

Wacht tot deze uitvoering is voltooid. Retourneert het statusobject na het wachten.

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

Parameters

show_output
<xref:bool>
standaardwaarde: False

Geeft aan of de uitvoer van de run op sys.stdout moet worden weer te geven.

wait_post_processing
<xref:bool>
standaardwaarde: False

Geeft aan of moet worden gewacht tot de naverwerking is voltooid nadat de run is voltooid.

raise_on_error
<xref:bool>
standaardwaarde: True

Geeft aan of er een fout wordt weergegeven wanneer de run de status Mislukt heeft.

Retouren

Het statusobject.

Retourtype

<xref:dict>

Kenmerken

description

De beschrijving van de run retourneren.

De optionele beschrijving van de run is een door de gebruiker opgegeven tekenreeks die nuttig is voor het beschrijven van een run.

Retouren

De beschrijving van de run.

Retourtype

<xref:str>

display_name

De weergavenaam van de run retourneren.

De optionele weergavenaam van de run is een door de gebruiker opgegeven tekenreeks die nuttig is voor latere identificatie van de run.

Retouren

De weergavenaam van de run.

Retourtype

<xref:str>

experiment

Experiment met de run op te halen.

Retouren

Hiermee haalt u het experiment op dat overeenkomt met de run.

Retourtype

id

Haal de run-id op.

De id van de run is een id die uniek is binnen het bevattende experiment.

Retouren

De run-id.

Retourtype

<xref:str>

name

AFGEKEURD. Gebruik display_name.

De optionele naam van de run is een door de gebruiker opgegeven tekenreeks die nuttig is voor latere identificatie van de run.

Retouren

De run-id.

Retourtype

<xref:str>

number

Haal het nummer van de run op.

Een monotone toename van het aantal dat de volgorde van de runs binnen een experiment vertegenwoordigt.

Retouren

Het nummer van de run.

Retourtype

<xref:int>

parent

Haal de bovenliggende run voor deze run op uit de service.

Runs kunnen een optioneel bovenliggend resultaat hebben, wat resulteert in een mogelijke structuurhiërarchie van runs. Als u metrische gegevens wilt aanmelden bij een bovenliggende run, gebruikt u log de methode van het bovenliggende object, bijvoorbeeld run.parent.log() .

Retouren

De bovenliggende run of Geen als er geen is ingesteld.

Retourtype

Run

properties

De onveranderbare eigenschappen van deze run retourneren.

Retouren

De eigenschappen van de run die lokaal in de cache zijn opgeslagen.

Retourtype

<xref:dict>[<xref:str>],
<xref:str>

Opmerkingen

Eigenschappen omvatten onveranderbare door het systeem gegenereerde informatie, zoals duur, uitvoeringsdatum, gebruiker, enzovoort.

status

Retourneren van de status van het run-object.

tags

Retourneert de set veranderlijke tags voor deze run.

Retouren

De tags die zijn opgeslagen op het run-object.

Retourtype

<xref:dict>

type

Voertype op.

Geeft aan hoe de run is gemaakt of geconfigureerd.

Retouren

Het type run.

Retourtype

<xref:str>