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.
Inicializar uma execução do HyperDrive.
Construtor
HyperDriveRun(experiment, run_id, hyperdrive_config=None, **kwargs)Parâmetros
| Nome | Description |
|---|---|
|
experiment
Obrigatório
|
O experimento para a execução do HyperDrive. |
|
run_id
Obrigatório
|
A ID de execução do HyperDrive. |
|
hyperdrive_config
|
A configuração para esta execução do HyperDrive. Valor padrão: None
|
|
experiment
Obrigatório
|
O experimento para a execução do HyperDrive. |
|
run_id
Obrigatório
|
A ID de execução do HyperDrive. |
|
hyperdrive_config
Obrigatório
|
A configuração para esta execução do HyperDrive. Se Nenhum, presumimos que a execução já existe e tentaremos se hidratar da nuvem. |
Métodos
| cancel |
Retornar True se a execução do HyperDrive tiver sido cancelada com êxito. |
| fail |
Não use. Não há suporte para o método fail para a subclasse HyperDriveRun. |
| get_best_run_by_primary_metric |
Localize e retorne a instância Executar que corresponde à execução com melhor desempenho entre todas as execuções filho. A execução com melhor desempenho é identificada exclusivamente com base no parâmetro de métrica primário especificado no HyperDriveConfig. O PrimaryMetricGoal determina 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 do ExperimentRun iniciadas por este HyperDriveRun, use get_metrics. Apenas uma das execuções é retornada, mesmo que várias das Execuções iniciadas por essa execução do HyperDrive atinjam a mesma melhor métrica. |
| get_children_sorted_by_primary_metric |
Retorne 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, as crianças serão retornadas em ordem decrescente de sua melhor métrica primária. Se inverter 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, elas serão acrescentadas à lista atrás de outras crianças com métrica primária. Observe que a opção inversa não tem impacto sobre elas. |
| get_diagnostics |
Não use. Não há suporte para o método get_diagnostics para a subclasse HyperDriveRun. |
| get_hyperparameters |
Retorne os hiperparâmetros para todas as execuções filho que foram lançadas por este HyperDriveRun. |
| get_metrics |
Retorne as métricas de todas as execuções que foram iniciadas por este HyperDriveRun. |
cancel
Retornar True se a execução do HyperDrive tiver sido cancelada com êxito.
cancel()Retornos
| Tipo | Description |
|---|---|
|
Se a execução foi cancelada com êxito ou não. |
fail
Não use. Não há suporte para o método fail para a subclasse HyperDriveRun.
fail()Exceções
| Tipo | Description |
|---|---|
get_best_run_by_primary_metric
Localize e retorne a instância Executar que corresponde à execução com melhor desempenho entre todas as execuções filho.
A execução com melhor desempenho é identificada exclusivamente com base no parâmetro de métrica primário especificado no HyperDriveConfig. O PrimaryMetricGoal determina 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 do ExperimentRun iniciadas por este HyperDriveRun, use get_metrics. Apenas uma das execuções é retornada, mesmo que várias das Execuções iniciadas por essa execução do HyperDrive atinjam 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
| Nome | Description |
|---|---|
|
include_failed
|
Se as execuções com falha devem ser incluídas. Valor padrão: True
|
|
include_canceled
|
Se deve incluir execuções canceladas. Valor padrão: True
|
|
include_resume_from_runs
|
Se deve incluir execuções de resume_from herdadas. Valor padrão: True
|
Retornos
| Tipo | Description |
|---|---|
|
A melhor Execução ou Nenhuma se nenhum filho tiver a métrica primária. |
get_children_sorted_by_primary_metric
Retorne 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, as crianças serão retornadas em ordem decrescente de sua melhor métrica primária. Se inverter 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, elas serão acrescentadas à lista atrás de outras crianças com métrica primária. Observe que a opção inversa não tem impacto sobre elas.
get_children_sorted_by_primary_metric(top=0, reverse=False, discard_no_metric=False)Parâmetros
| Nome | Description |
|---|---|
|
top
|
Número de filhos principais a serem retornados. Se for 0, todas as crianças serão retornadas. Valor padrão: 0
|
|
reverse
|
Se for True, a ordem será invertida. Ele só afeta crianças com a métrica primária. Valor padrão: False
|
|
discard_no_metric
|
Se for False, os filhos sem métrica primária serão acrescentados à lista. Valor padrão: False
|
Retornos
| Tipo | Description |
|---|---|
|
Lista de dicionários com id de execução, hiperparâmetros, melhor métrica primária e status |
get_diagnostics
Não use. Não há suporte para o método get_diagnostics para a subclasse HyperDriveRun.
get_diagnostics()Exceções
| Tipo | Description |
|---|---|
get_hyperparameters
Retorne os hiperparâmetros para todas as execuções filho que foram lançadas por este HyperDriveRun.
get_hyperparameters()Retornos
| Tipo | Description |
|---|---|
|
Hiperparâmetros para todas as execuções filho. É 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()Retornos
| Tipo | Description |
|---|---|
|
As métricas para todos os filhos dessa execução. |
Atributos
hyperdrive_config
Retorne a configuração de execução do hyperdrive.
Retornos
| Tipo | Description |
|---|---|
|
A 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'