HyperDriveRun Classe
O HyperDriveRun contém os detalhes de um experimento do HyperDrive enviado.
Essa classe pode ser usada para gerenciar, verificar o status e recuperar detalhes de execução para a execução do HyperDrive e cada uma das execuções filho geradas.
Inicialize uma execução do HyperDrive.
Construtor
HyperDriveRun(experiment, run_id, hyperdrive_config=None, **kwargs)Parâmetros
| Name | Description |
|---|---|
|
experiment
Necessário
|
O experimento para o HyperDrive é executado. |
|
run_id
Necessário
|
O ID de execução do HyperDrive. |
|
hyperdrive_config
|
A configuração para este HyperDrive é executada. Default value: None
|
|
experiment
Necessário
|
O experimento para o HyperDrive é executado. |
|
run_id
Necessário
|
A ID de execução do HyperDrive. |
|
hyperdrive_config
Necessário
|
A configuração para este HyperDrive é executada. Se Nenhum, assumimos que a corrida já existe e tentaremos hidratar a partir da nuvem. |
Métodos
| cancel |
Retorne True se a execução do HyperDrive tiver sido cancelada com êxito. |
| fail |
Não utilizar. O método fail não é suportado para a subclasse HyperDriveRun. |
| get_best_run_by_primary_metric |
Localize e retorne a instância Run que corresponde à execução com melhor desempenho entre todas as execuções filhas. A execução com melhor desempenho é identificada exclusivamente com base no parâmetro métrico primário especificado no HyperDriveConfig. O PrimaryMetricGoal governa se o mínimo ou o máximo da métrica primária é usado. Para fazer uma análise mais detalhada de todas as métricas ExperimentRun lançadas por este HyperDriveRun, use get_metrics. Apenas uma das execuções é retornada, mesmo que várias das execuções lançadas por esta execução do HyperDrive tenham atingido a mesma melhor métrica. |
| get_children_sorted_by_primary_metric |
Retornar uma lista de crianças classificadas por sua melhor métrica primária. A classificação é feita de acordo com a métrica primária e seu objetivo: se for maximizar, então as crianças são devolvidas em ordem decrescente de sua melhor métrica primária. Se o inverso for True, a ordem será invertida. Cada filho no resultado tem id de execução, hiperparâmetros, melhor valor de métrica primária e status. Crianças sem métrica primária são descartadas quando discard_no_metric é True. Caso contrário, eles são anexados à lista atrás de outras crianças com métrica primária. Note que a opção inversa não tem impacto sobre eles. |
| get_diagnostics |
Não utilizar. O método get_diagnostics não é suportado para a subclasse HyperDriveRun. |
| get_hyperparameters |
Retornar os hiperparâmetros para todas as execuções filho que foram iniciadas por este HyperDriveRun. |
| get_metrics |
Retorne as métricas de todas as execuções que foram iniciadas por este HyperDriveRun. |
cancel
Retorne True se a execução do HyperDrive tiver sido cancelada com êxito.
cancel()Devoluções
| Tipo | Description |
|---|---|
|
Se a execução foi ou não cancelada com sucesso. |
fail
Não utilizar. O método fail não é suportado para a subclasse HyperDriveRun.
fail()Exceções
| Tipo | Description |
|---|---|
get_best_run_by_primary_metric
Localize e retorne a instância Run que corresponde à execução com melhor desempenho entre todas as execuções filhas.
A execução com melhor desempenho é identificada exclusivamente com base no parâmetro métrico primário especificado no HyperDriveConfig. O PrimaryMetricGoal governa se o mínimo ou o máximo da métrica primária é usado. Para fazer uma análise mais detalhada de todas as métricas ExperimentRun lançadas por este HyperDriveRun, use get_metrics. Apenas uma das execuções é retornada, mesmo que várias das execuções lançadas por esta execução do HyperDrive tenham atingido a mesma melhor métrica.
get_best_run_by_primary_metric(include_failed=True, include_canceled=True, include_resume_from_runs=True) -> Run | NoneParâmetros
| Name | Description |
|---|---|
|
include_failed
|
Se as execuções com falha devem ser incluídas. Default value: True
|
|
include_canceled
|
Se as execuções canceladas devem ser incluídas. Default value: True
|
|
include_resume_from_runs
|
Se as execuções de resume_from herdadas devem ser incluídas. Default value: True
|
Devoluções
| Tipo | Description |
|---|---|
|
A melhor Execução, ou Nenhuma se nenhuma criança tiver a métrica principal. |
get_children_sorted_by_primary_metric
Retornar uma lista de crianças classificadas por sua melhor métrica primária.
A classificação é feita de acordo com a métrica primária e seu objetivo: se for maximizar, então as crianças são devolvidas em ordem decrescente de sua melhor métrica primária. Se o inverso for True, a ordem será invertida.
Cada filho no resultado tem id de execução, hiperparâmetros, melhor valor de métrica primária e status.
Crianças sem métrica primária são descartadas quando discard_no_metric é True. Caso contrário, eles são anexados à lista atrás de outras crianças com métrica primária. Note que a opção inversa não tem impacto sobre eles.
get_children_sorted_by_primary_metric(top=0, reverse=False, discard_no_metric=False)Parâmetros
| Name | Description |
|---|---|
|
top
|
Número de crianças a serem devolvidas. Se for 0, todas as crianças serão devolvidas. Default value: 0
|
|
reverse
|
Se for True, a ordem será invertida. Só afeta crianças com métrica primária. Default value: False
|
|
discard_no_metric
|
Se for False, as crianças sem métrica primária serão anexadas à lista. Default value: False
|
Devoluções
| Tipo | Description |
|---|---|
|
Lista de dicionários com id de execução, hiperparâmetros, melhor métrica primária e status |
get_diagnostics
Não utilizar. O método get_diagnostics não é suportado para a subclasse HyperDriveRun.
get_diagnostics()Exceções
| Tipo | Description |
|---|---|
get_hyperparameters
Retornar os hiperparâmetros para todas as execuções filho que foram iniciadas por este HyperDriveRun.
get_hyperparameters()Devoluções
| Tipo | Description |
|---|---|
|
Hiperparâmetros para todas as execuções filhas. É um dicionário com run_id como chave. |
get_metrics
Retorne as métricas de todas as execuções que foram iniciadas por este HyperDriveRun.
get_metrics()Devoluções
| Tipo | Description |
|---|---|
|
As métricas para todas as crianças desta corrida. |
Atributos
hyperdrive_config
Retorne a configuração de execução do hyperdrive.
Devoluções
| Tipo | Description |
|---|---|
|
O hyperdrive executa a configuração. |
HYPER_DRIVE_RUN_USER_AGENT
HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'RUN_TYPE
RUN_TYPE = 'hyperdrive'