Delen via


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.

Constructor

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

Parameters

Name Description
experiment
Vereist

Het experiment voor de HyperDrive-uitvoering.

run_id
Vereist
str

De HyperDrive-uitvoerings-id.

hyperdrive_config

De configuratie voor deze HyperDrive wordt uitgevoerd.

Default value: None
experiment
Vereist

Het experiment voor de HyperDrive-uitvoering.

run_id
Vereist
str

De HyperDrive-uitvoerings-id.

hyperdrive_config
Vereist

De configuratie voor deze HyperDrive wordt uitgevoerd. Als geen, gaan we ervan uit dat de uitvoering al bestaat en zal proberen te hydrateren vanuit de cloud.

Methoden

cancel

Retourneer Waar als de HyperDrive-uitvoering is geannuleerd.

fail

Niet gebruiken. De failmethode wordt niet ondersteund voor de Subklasse HyperDriveRun.

get_best_run_by_primary_metric

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

De best presterende uitvoering wordt alleen geïdentificeerd op basis van de primaire metrische parameter die is opgegeven in de HyperDriveConfig. De PrimaryMetricGoal bepaalt of het minimum of maximum van de primaire metriek wordt gebruikt. Gebruik get_metrics om een gedetailleerdere analyse uit te voeren van alle metrische experimentrungegevens die door deze HyperDriveRun worden gestart. Er wordt slechts één van de uitvoeringen geretourneerd, zelfs als meerdere uitvoeringen die door deze HyperDrive-uitvoering worden gestart, dezelfde beste meetwaarde hebben bereikt.

get_children_sorted_by_primary_metric

Retourneert een lijst met onderliggende items die zijn gesorteerd op de beste primaire metrische waarde.

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

Elk onderliggend element in het resultaat heeft run id, hyperparameters, beste primaire metrische waarde en status.

Onderliggende items zonder primaire metrische gegevens worden genegeerd 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 get_diagnostics-methode wordt niet ondersteund voor de Subklasse HyperDriveRun.

get_hyperparameters

Hiermee worden de hyperparameters geretourneerd voor alle onderliggende uitvoeringen die zijn gestart door deze HyperDriveRun.

get_metrics

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

cancel

Retourneer Waar als de HyperDrive-uitvoering is geannuleerd.

cancel()

Retouren

Type Description

Of de uitvoering al dan niet is geannuleerd.

fail

Niet gebruiken. De failmethode wordt niet ondersteund voor de Subklasse HyperDriveRun.

fail()

Uitzonderingen

Type Description

get_best_run_by_primary_metric

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

De best presterende uitvoering wordt alleen geïdentificeerd op basis van de primaire metrische parameter die is opgegeven in de HyperDriveConfig. De PrimaryMetricGoal bepaalt of het minimum of maximum van de primaire metriek wordt gebruikt. Gebruik get_metrics om een gedetailleerdere analyse uit te voeren van alle metrische experimentrungegevens die door deze HyperDriveRun worden gestart. Er wordt slechts één van de uitvoeringen geretourneerd, zelfs als meerdere uitvoeringen die door deze HyperDrive-uitvoering worden gestart, dezelfde beste meetwaarde hebben bereikt.

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

Parameters

Name Description
include_failed

Of mislukte uitvoeringen moeten worden opgenomen.

Default value: True
include_canceled

Of geannuleerde uitvoeringen moeten worden opgenomen.

Default value: True
include_resume_from_runs

Of overgenomen resume_from uitvoeringen moeten worden opgenomen.

Default value: True

Retouren

Type Description
Run

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

get_children_sorted_by_primary_metric

Retourneert een lijst met onderliggende items die zijn gesorteerd op de beste primaire metrische waarde.

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

Elk onderliggend element in het resultaat heeft run id, hyperparameters, beste primaire metrische waarde en status.

Onderliggende items zonder primaire metrische gegevens worden genegeerd 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

Name Description
top
int

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

Default value: 0
reverse

Als het waar is, wordt de volgorde omgekeerd. Dit heeft alleen gevolgen voor kinderen met primaire metrische gegevens.

Default value: False
discard_no_metric

Als dit Onwaar is, worden onderliggende items zonder primaire metrische waarde toegevoegd aan de lijst.

Default value: False

Retouren

Type Description

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

get_diagnostics

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

get_diagnostics()

Uitzonderingen

Type Description

get_hyperparameters

Hiermee worden de hyperparameters geretourneerd voor alle onderliggende uitvoeringen die zijn gestart door deze HyperDriveRun.

get_hyperparameters()

Retouren

Type Description

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

get_metrics

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

get_metrics()

Retouren

Type Description

De metrische gegevens voor alle onderliggende items van deze uitvoering.

Kenmerken

hyperdrive_config

Retourneer de configuratie van de hyperdrive-uitvoering.

Retouren

Type Description

De configuratie van de hyperdrive-uitvoering.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'