HyperDriveRun Klas

HyperDriveRun bevat de details van een verzonden HyperDrive-experiment.

Deze klasse kan worden gebruikt voor het beheren, controleren van de status en het ophalen van uitvoeringsdetails voor de HyperDrive-uitvoering en elk van de gegenereerde onderliggende uitvoeringen.

Initialiseer een HyperDrive-uitvoering.

Overname

Run

HyperDriveRun

Constructor

HyperDriveRun(experiment, run_id, hyperdrive_config=None, **kwargs)

Parameters

experiment

Experiment

Vereist

Het experiment voor de HyperDrive-uitvoering.

run_id

str

Vereist

De HyperDrive-uitvoerings-id.

hyperdrive_config

HyperDriveConfig

standaardwaarde: None

De configuratie voor deze HyperDrive-uitvoering.

experiment

Experiment

Vereist

Het experiment voor de HyperDrive-uitvoering.

run_id

str

Vereist

De HyperDrive-uitvoerings-id.

hyperdrive_config

HyperDriveConfig

Vereist

De configuratie voor deze HyperDrive-uitvoering. Bij Geen gaan we ervan uit dat de uitvoering al bestaat en wordt geprobeerd om te hydrateren vanuit de cloud.

Methoden

cancel	Retourneer Waar als de HyperDrive-uitvoering is geannuleerd.
fail	Niet gebruiken. De fail-methode wordt niet ondersteund voor de subklasse HyperDriveRun.
get_best_run_by_primary_metric	Zoek en retourneer het uitvoeringsexemplaar dat overeenkomt met de best presterende uitvoering van alle onderliggende uitvoeringen. De best presterende uitvoering wordt uitsluitend geïdentificeerd op basis van de primaire metrische parameter die is opgegeven in de HyperDriveConfig. De PrimaryMetricGoal bepaalt of het minimum of maximum van het primaire metrische gegeven wordt gebruikt. Als u een gedetailleerdere analyse wilt uitvoeren van alle metrische gegevens van ExperimentRun die door deze HyperDriveRun worden gestart, gebruikt u get_metrics. Slechts één van de uitvoeringen wordt geretourneerd, zelfs als meerdere van de uitvoeringen die door deze HyperDrive-uitvoering zijn gestart, dezelfde beste metrische waarde hebben bereikt.
get_children_sorted_by_primary_metric	Retourneert een lijst met onderliggende items gesorteerd op hun beste primaire metrische gegevens. De sortering wordt uitgevoerd op basis van het primaire metrische gegeven en het doel ervan: als deze is gemaximaliseerd, worden de onderliggende items geretourneerd in aflopende volgorde van hun beste primaire metrische waarde. Als omgekeerd Waar is, wordt de volgorde omgekeerd. Elk onderliggend item in het resultaat heeft de uitvoerings-id, hyperparameters, de beste primaire metrische waarde en de status. Onderliggende items zonder primaire metrische gegevens worden verwijderd wanneer discard_no_metric Waar is. Anders worden ze toegevoegd aan de lijst achter andere onderliggende items met primaire metrische gegevens. Houd er rekening mee dat de omgekeerde optie geen invloed heeft op deze opties.
get_diagnostics	Niet gebruiken. De methode get_diagnostics wordt niet ondersteund voor de subklasse HyperDriveRun.
get_hyperparameters	Retourneer de hyperparameters voor alle onderliggende uitvoeringen die door deze HyperDriveRun zijn gestart.
get_metrics	Retourneert de metrische gegevens van alle uitvoeringen die door deze HyperDriveRun zijn gestart.

cancel

Retourneer Waar als de HyperDrive-uitvoering is geannuleerd.

cancel()

Retouren

Of de uitvoering is geannuleerd of niet.

Retourtype

bool

fail

Niet gebruiken. De fail-methode wordt niet ondersteund voor de subklasse HyperDriveRun.

fail()

Uitzonderingen

HyperDriveNotImplementedException

get_best_run_by_primary_metric

Zoek en retourneer het uitvoeringsexemplaar dat overeenkomt met de best presterende uitvoering van alle onderliggende uitvoeringen.

De best presterende uitvoering wordt uitsluitend geïdentificeerd op basis van de primaire metrische parameter die is opgegeven in de HyperDriveConfig. De PrimaryMetricGoal bepaalt of het minimum of maximum van het primaire metrische gegeven wordt gebruikt. Als u een gedetailleerdere analyse wilt uitvoeren van alle metrische gegevens van ExperimentRun die door deze HyperDriveRun worden gestart, gebruikt u get_metrics. Slechts één van de uitvoeringen wordt geretourneerd, zelfs als meerdere van de uitvoeringen die door deze HyperDrive-uitvoering zijn gestart, dezelfde beste metrische waarde hebben bereikt.

get_best_run_by_primary_metric(include_failed=True, include_canceled=True, include_resume_from_runs=True) -> Run | None

Parameters

include_failed

bool

standaardwaarde: True

Of mislukte uitvoeringen moeten worden opgenomen.

include_canceled

bool

standaardwaarde: True

Of geannuleerde uitvoeringen moeten worden opgenomen.

include_resume_from_runs

bool

standaardwaarde: True

Of overgenomen resume_from-uitvoeringen moeten worden opgenomen.

Retouren

De beste uitvoering of Geen als geen onderliggend item de primaire metrische waarde heeft.

Retourtype

Run

get_children_sorted_by_primary_metric

Retourneert een lijst met onderliggende items gesorteerd op hun beste primaire metrische gegevens.

De sortering wordt uitgevoerd op basis van het primaire metrische gegeven en het doel ervan: als deze is gemaximaliseerd, worden de onderliggende items geretourneerd in aflopende volgorde van hun beste primaire metrische waarde. Als omgekeerd Waar is, wordt de volgorde omgekeerd.

Elk onderliggend item in het resultaat heeft de uitvoerings-id, hyperparameters, de beste primaire metrische waarde en de status.

Onderliggende items zonder primaire metrische gegevens worden verwijderd wanneer discard_no_metric Waar is. Anders worden ze toegevoegd aan de lijst achter andere onderliggende items met primaire metrische gegevens. Houd er rekening mee dat de omgekeerde optie geen invloed heeft op deze opties.

get_children_sorted_by_primary_metric(top=0, reverse=False, discard_no_metric=False)

Parameters

top

int

standaardwaarde: 0

Het aantal belangrijkste onderliggende items dat moet worden geretourneerd. Als het 0 is, worden alle onderliggende items geretourneerd.

reverse

bool

standaardwaarde: False

Als deze Waar is, wordt de volgorde omgekeerd. Dit is alleen van invloed op kinderen met primaire metrische gegevens.

discard_no_metric

bool

standaardwaarde: False

Als het Onwaar is, worden onderliggende items zonder primaire metrische gegevens toegevoegd aan de lijst.

Retouren

Lijst met woordenlijsten met uitvoerings-id, hyperparameters, beste primaire metrische gegevens en status

Retourtype

list

get_diagnostics

Niet gebruiken. De methode get_diagnostics wordt niet ondersteund voor de subklasse HyperDriveRun.

get_diagnostics()

Uitzonderingen

HyperDriveNotImplementedException

get_hyperparameters

Retourneer de hyperparameters voor alle onderliggende uitvoeringen die door deze HyperDriveRun zijn gestart.

get_hyperparameters()

Retouren

Hyperparameters voor alle onderliggende uitvoeringen. Het is een woordenlijst met run_id als sleutel.

Retourtype

dict

get_metrics

Retourneert de metrische gegevens van alle uitvoeringen die door deze HyperDriveRun zijn gestart.

get_metrics()

Retouren

De metrische gegevens voor alle onderliggende items van deze uitvoering.

Retourtype

dict

Kenmerken

hyperdrive_config

Retourneer de hyperdrive-uitvoeringsconfiguratie.

Retouren

De configuratie van de hyperdrive-uitvoering.

Retourtype

HyperDriveConfig

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'