HyperDriveRun Classe

HyperDriveRun contém os detalhes de uma experimentação do HyperDrive submetida.

Esta classe pode ser utilizada para gerir, verificar o estado e obter os detalhes da execução do HyperDrive e cada uma das execuções subordinadas geradas.

Inicializar uma execução do HyperDrive.

Herança

Run

HyperDriveRun

Construtor

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

Parâmetros

experiment

Experiment

Necessário

A experimentação da execução do HyperDrive.

run_id

str

Necessário

O ID de execução do HyperDrive.

hyperdrive_config

HyperDriveConfig

valor predefinido: None

A configuração para esta execução do HyperDrive.

experiment

Experiment

Necessário

A experimentação da execução do HyperDrive.

run_id

str

Necessário

O ID de execução do HyperDrive.

hyperdrive_config

HyperDriveConfig

Necessário

A configuração para esta execução do HyperDrive. Se Não, partimos do princípio de que a execução já existe e tentará hidratar-se a partir da cloud.

Métodos

cancel	Devolver Verdadeiro se a execução do HyperDrive tiver sido cancelada com êxito.
fail	Não utilizar. O método de falha não é suportado para a subclasse HyperDriveRun.
get_best_run_by_primary_metric	Localize e devolva a instância Executar que corresponde à execução com melhor desempenho entre todas as execuções subordinadas. A execução com melhor desempenho é identificada apenas com base no parâmetro de métrica principal especificado no HyperDriveConfig. O PrimaryMetricGoal governa se é utilizado o mínimo ou o máximo da métrica primária. Para fazer uma análise mais detalhada de todas as métricas ExperimentRun iniciadas por este HyperDriveRun, utilize get_metrics. Apenas uma das execuções é devolvida, mesmo que várias das Execuções iniciadas por esta execução do HyperDrive atinjam a mesma melhor métrica.
get_children_sorted_by_primary_metric	Devolver uma lista de menores ordenados pela sua melhor métrica primária. A ordenação é feita de acordo com a métrica primária e o seu objetivo: se for maximizante, as crianças são devolvidas por ordem descendente da sua melhor métrica primária. Se inverso for Verdadeiro, a ordem é invertida. Cada elemento subordinado no resultado executou o ID, os hiperparâmetros, o melhor valor e estado da métrica principal. As crianças sem métrica primária são eliminadas quando discard_no_metric é Verdadeiro. Caso contrário, são anexados à lista por trás de outras crianças com métrica primária. Tenha em atenção que a opção inversa não tem impacto nos mesmos.
get_diagnostics	Não utilizar. O método get_diagnostics não é suportado para a subclasse HyperDriveRun.
get_hyperparameters	Devolva os hiperparâmetros de todas as execuções subordinadas que foram iniciadas por este HyperDriveRun.
get_metrics	Devolver as métricas de todas as execuções que foram iniciadas por este HyperDriveRun.

cancel

Devolver Verdadeiro se a execução do HyperDrive tiver sido cancelada com êxito.

cancel()

Devoluções

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

Tipo de retorno

bool

fail

Não utilizar. O método de falha não é suportado para a subclasse HyperDriveRun.

fail()

Exceções

HyperDriveNotImplementedException

get_best_run_by_primary_metric

Localize e devolva a instância Executar que corresponde à execução com melhor desempenho entre todas as execuções subordinadas.

A execução com melhor desempenho é identificada apenas com base no parâmetro de métrica principal especificado no HyperDriveConfig. O PrimaryMetricGoal governa se é utilizado o mínimo ou o máximo da métrica primária. Para fazer uma análise mais detalhada de todas as métricas ExperimentRun iniciadas por este HyperDriveRun, utilize get_metrics. Apenas uma das execuções é devolvida, mesmo que várias das Execuções iniciadas por esta 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 | None

Parâmetros

include_failed

bool

valor predefinido: True

Se pretende incluir execuções falhadas.

include_canceled

bool

valor predefinido: True

Se pretende incluir execuções canceladas.

include_resume_from_runs

bool

valor predefinido: True

Se pretende incluir execuções de resume_from herdadas.

Devoluções

A melhor Execução ou Nenhuma se nenhum subordinado tiver a métrica primária.

Tipo de retorno

Run

get_children_sorted_by_primary_metric

Devolver uma lista de menores ordenados pela sua melhor métrica primária.

A ordenação é feita de acordo com a métrica primária e o seu objetivo: se for maximizante, as crianças são devolvidas por ordem descendente da sua melhor métrica primária. Se inverso for Verdadeiro, a ordem é invertida.

Cada elemento subordinado no resultado executou o ID, os hiperparâmetros, o melhor valor e estado da métrica principal.

As crianças sem métrica primária são eliminadas quando discard_no_metric é Verdadeiro. Caso contrário, são anexados à lista por trás de outras crianças com métrica primária. Tenha em atenção que a opção inversa não tem impacto nos mesmos.

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

Parâmetros

top

int

valor predefinido: 0

Número de crianças de topo a serem devolvidas. Se for 0, todas as crianças serão devolvidas.

reverse

bool

valor predefinido: False

Se for Verdadeiro, a encomenda será invertida. Afeta apenas as crianças com métricas primárias.

discard_no_metric

bool

valor predefinido: False

Se for Falso, as crianças sem métrica primária serão anexadas à lista.

Devoluções

Lista de dicionários com id de execução, hiperparâmetros, melhor métrica primária e estado

Tipo de retorno

list

get_diagnostics

Não utilizar. O método get_diagnostics não é suportado para a subclasse HyperDriveRun.

get_diagnostics()

Exceções

HyperDriveNotImplementedException

get_hyperparameters

Devolva os hiperparâmetros de todas as execuções subordinadas que foram iniciadas por este HyperDriveRun.

get_hyperparameters()

Devoluções

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

Tipo de retorno

dict

get_metrics

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

get_metrics()

Devoluções

As métricas para todos os subordinados desta execução.

Tipo de retorno

dict

Atributos

hyperdrive_config

Devolver a configuração da execução do hyperdrive.

Devoluções

A configuração de execução do hyperdrive.

Tipo de retorno

HyperDriveConfig

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'