HyperDriveRun Classe

  • Referência

O HyperDriveRun contém os detalhes de um experimento do HyperDrive enviado.

Essa classe pode ser usada para gerenciar, verificar status e recuperar detalhes da execução do HyperDrive e cada uma das execuções filhas geradas.

Inicializar uma execução do HyperDrive.

Herança
Run
HyperDriveRun

Construtor

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

Parâmetros

Nome Description
experiment
Obrigatório
Experiment

Experimento para a execução do HyperDrive.
run_id
Obrigatório
str

ID de execução do HyperDrive.
hyperdrive_config
HyperDriveConfig

Configuração para esta execução de HyperDrive.

Valor padrão: None
experiment
Obrigatório
Experiment

Experimento para a execução do HyperDrive.
run_id
Obrigatório
str

A ID de execução do HyperDrive.
hyperdrive_config
Obrigatório
HyperDriveConfig

Configuração para esta execução de HyperDrive. Se Nenhum, presumimos que a execução já existe e tentaremos se hidratar da nuvem.

Métodos

cancel

Retorna True se a execução do HyperDrive tiver sido cancelada com êxito.
fail

Não use. Não há suporte ao método Fail para a subclasse HyperDriveRun.
get_best_run_by_primary_metric

Localiza e retorna a instância de execução que corresponde à execução de melhor desempenho entre todas as execuções filhas.

A execução de melhor desempenho é identificada exclusivamente com base no parâmetro de métrica primário especificado no HyperDriveConfig. O PrimaryMetricGoal rege se é usado o mínimo ou o máximo da métrica primária. Para fazer uma análise mais detalhada de todas as métricas de ExperimentRun inicializadas por esse HyperDriveRun, use get_metrics. Somente uma das execuções é retornada, mesmo que várias execuções iniciadas por essa execução de HyperDrive tenham atingido o mesmo valor de melhor métrica.
get_children_sorted_by_primary_metric

Retorna uma lista de filhos classificados por sua melhor métrica primária.

A classificação é feita de acordo com a métrica primária e sua meta: se for maximizada, os filhos serão retornados em ordem decrescente da melhor métrica primária. Se Reverse for True, a ordem será invertida.

Cada filho no resultado tem ID de execução, hiperparâmetros, melhor valor principal de métrica e status.

Os filhos sem a métrica primária serão descartados quando discard_no_metric for True. Caso contrário, eles serão anexados à lista por trás de outros filhos com a métrica primária. Observe que a opção Reverse não tem nenhum impacto sobre elas.
get_diagnostics

Não use. Não há suporte ao método Fail para a subclasse HyperDriveRun.
get_hyperparameters

Retorna os hiperparâmetros para todas as execuções filhas que foram iniciadas por este HyperDriveRun.
get_metrics

Retorna as métricas de todas as execuções que foram iniciadas por este HyperDriveRun.

cancel

Retorna True se a execução do HyperDrive tiver sido cancelada com êxito.

cancel()

Retornos

Tipo Description
bool

Se a execução foi cancelada com êxito ou não.

fail

Não use. Não há suporte ao método Fail para a subclasse HyperDriveRun.

fail()

Exceções

Tipo Description
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Localiza e retorna a instância de execução que corresponde à execução de melhor desempenho entre todas as execuções filhas.

A execução de melhor desempenho é identificada exclusivamente com base no parâmetro de métrica primário especificado no HyperDriveConfig. O PrimaryMetricGoal rege se é usado o mínimo ou o máximo da métrica primária. Para fazer uma análise mais detalhada de todas as métricas de ExperimentRun inicializadas por esse HyperDriveRun, use get_metrics. Somente uma das execuções é retornada, mesmo que várias execuções iniciadas por essa execução de HyperDrive tenham atingido o mesmo valor de melhor métrica.

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

Parâmetros

Nome Description
include_failed
bool

Se as execuções com falha devem ser incluídas.

Valor padrão: True
include_canceled
bool

Se as execuções canceladas devem ser incluídas.

Valor padrão: True
include_resume_from_runs
bool

Se as execuções herdadas de resume_from devem ser incluídas.

Valor padrão: True

Retornos

Tipo Description
Run

A melhor execução, ou nenhum, se nenhum filho tiver a métrica primária.

get_children_sorted_by_primary_metric

Retorna uma lista de filhos classificados por sua melhor métrica primária.

A classificação é feita de acordo com a métrica primária e sua meta: se for maximizada, os filhos serão retornados em ordem decrescente da melhor métrica primária. Se Reverse for True, a ordem será invertida.

Cada filho no resultado tem ID de execução, hiperparâmetros, melhor valor principal de métrica e status.

Os filhos sem a métrica primária serão descartados quando discard_no_metric for True. Caso contrário, eles serão anexados à lista por trás de outros filhos com a métrica primária. Observe que a opção Reverse não tem nenhum impacto sobre elas.

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

Parâmetros

Nome Description
top
int

Número de filhos principais a serem retornados. Se for 0, todos os filhos serão retornados.

Valor padrão: 0
reverse
bool

Se for True, a ordem será invertida. Afeta apenas os filhos com a métrica primária.

Valor padrão: False
discard_no_metric
bool

Se for False, os filhos sem a métrica primária serão acrescentados à lista.

Valor padrão: False

Retornos

Tipo Description
list

Lista de dicionários com ID de execução, hiperparâmetros, melhor métrica principal e status

get_diagnostics

Não use. Não há suporte ao método Fail para a subclasse HyperDriveRun.

get_diagnostics()

Exceções

Tipo Description
HyperDriveNotImplementedException

get_hyperparameters

Retorna os hiperparâmetros para todas as execuções filhas que foram iniciadas por este HyperDriveRun.

get_hyperparameters()

Retornos

Tipo Description
dict

Hiperparâmetros para todas as execuções filhas. É um dicionário com run_id como chave.

get_metrics

Retorna as métricas de todas as execuções que foram iniciadas por este HyperDriveRun.

get_metrics()

Retornos

Tipo Description
dict

Métricas de todos os filhos desta execução.

Atributos

hyperdrive_config

Retorna a configuração de execução do HyperDrive.

Retornos

Tipo Description
HyperDriveConfig

Configuração de execução do HyperDrive.

HYPER_DRIVE_RUN_USER_AGENT 

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE 

RUN_TYPE = 'hyperdrive'