HyperDriveRun Clase
HyperDriveRun contiene los detalles de un experimento de HyperDrive enviado.
Esta clase se puede usar para administrar, comprobar el estado y recuperar los detalles de ejecución de la ejecución de HyperDrive y cada una de las ejecuciones secundarias generadas.
Inicialice una ejecución de HyperDrive.
- Herencia
-
HyperDriveRun
Constructor
HyperDriveRun(experiment, run_id, hyperdrive_config=None, **kwargs)Parámetros
| Nombre | Description |
|---|---|
|
experiment
Requerido
|
Experimento para la ejecución de HyperDrive. |
|
run_id
Requerido
|
Id. de ejecución de HyperDrive. |
|
hyperdrive_config
|
Configuración de esta ejecución de HyperDrive. Valor predeterminado: None
|
|
experiment
Requerido
|
Experimento para la ejecución de HyperDrive. |
|
run_id
Requerido
|
Identificador de ejecución de HyperDrive. |
|
hyperdrive_config
Requerido
|
Configuración de esta ejecución de HyperDrive. Si ninguno, se supone que la ejecución ya existe e intentará hidratarse desde la nube. |
Métodos
| cancel |
Devuelve True si la ejecución de HyperDrive se canceló correctamente. |
| fail |
No debe usarse. El método de error no se admite para la subclase HyperDriveRun. |
| get_best_run_by_primary_metric |
Busca y devuelve la instancia de ejecución correspondiente a la ejecución con mejor rendimiento entre todas las ejecuciones secundarias. La ejecución de mejor rendimiento se identifica únicamente en función del parámetro de métrica principal especificado en HyperDriveConfig. PrimaryMetricGoal rige si se usa el mínimo o máximo de la métrica principal. Para realizar un análisis más detallado de todas las métricas ExperimentRun iniciadas por este HyperDriveRun, use get_metrics. Solo se devuelve una de las ejecuciones, incluso si varias de las ejecuciones iniciadas por esta ejecución de HyperDrive alcanzaron la misma métrica. |
| get_children_sorted_by_primary_metric |
Devuelve una lista de elementos secundarios ordenados por su mejor métrica principal. La ordenación se realiza según la métrica principal y su objetivo: si se maximiza, los elementos secundarios se devuelven en orden descendente de su mejor métrica principal. Si reverse es True, se invierte el orden. Cada elemento secundario del resultado tiene identificador de ejecución, hiperparámetros, mejor valor de métrica principal y estado. Los elementos secundarios sin métrica principal se descartan cuando discard_no_metric es True. De lo contrario, se anexan a la lista detrás de otros elementos secundarios con métrica principal. Tenga en cuenta que la opción reverse no tiene ningún impacto en ellos. |
| get_diagnostics |
No debe usarse. El método get_diagnostics no se admite para la subclase HyperDriveRun. |
| get_hyperparameters |
Devuelve los hiperparámetros de todas las ejecuciones secundarias que se iniciaron mediante este HyperDriveRun. |
| get_metrics |
Devuelve las métricas de todas las ejecuciones iniciadas por este HyperDriveRun. |
cancel
Devuelve True si la ejecución de HyperDrive se canceló correctamente.
cancel()Devoluciones
| Tipo | Description |
|---|---|
|
Si la ejecución se canceló correctamente o no. |
fail
No debe usarse. El método de error no se admite para la subclase HyperDriveRun.
fail()Excepciones
| Tipo | Description |
|---|---|
get_best_run_by_primary_metric
Busca y devuelve la instancia de ejecución correspondiente a la ejecución con mejor rendimiento entre todas las ejecuciones secundarias.
La ejecución de mejor rendimiento se identifica únicamente en función del parámetro de métrica principal especificado en HyperDriveConfig. PrimaryMetricGoal rige si se usa el mínimo o máximo de la métrica principal. Para realizar un análisis más detallado de todas las métricas ExperimentRun iniciadas por este HyperDriveRun, use get_metrics. Solo se devuelve una de las ejecuciones, incluso si varias de las ejecuciones iniciadas por esta ejecución de HyperDrive alcanzaron la misma métrica.
get_best_run_by_primary_metric(include_failed=True, include_canceled=True, include_resume_from_runs=True) -> Run | NoneParámetros
| Nombre | Description |
|---|---|
|
include_failed
|
Si se deben incluir ejecuciones con errores. Valor predeterminado: True
|
|
include_canceled
|
Si se deben incluir ejecuciones canceladas. Valor predeterminado: True
|
|
include_resume_from_runs
|
Si se deben incluir ejecuciones de resume_from heredadas. Valor predeterminado: True
|
Devoluciones
| Tipo | Description |
|---|---|
|
La mejor Ejecución o Ninguna si ningún elemento secundario tiene la métrica principal. |
get_children_sorted_by_primary_metric
Devuelve una lista de elementos secundarios ordenados por su mejor métrica principal.
La ordenación se realiza según la métrica principal y su objetivo: si se maximiza, los elementos secundarios se devuelven en orden descendente de su mejor métrica principal. Si reverse es True, se invierte el orden.
Cada elemento secundario del resultado tiene identificador de ejecución, hiperparámetros, mejor valor de métrica principal y estado.
Los elementos secundarios sin métrica principal se descartan cuando discard_no_metric es True. De lo contrario, se anexan a la lista detrás de otros elementos secundarios con métrica principal. Tenga en cuenta que la opción reverse no tiene ningún impacto en ellos.
get_children_sorted_by_primary_metric(top=0, reverse=False, discard_no_metric=False)Parámetros
| Nombre | Description |
|---|---|
|
top
|
Número de elementos secundarios principales que se devolverán. Si es 0, se devolverán todos los elementos secundarios. Valor predeterminado: 0
|
|
reverse
|
Si es True, se invertirá el orden. Solo afecta a los elementos secundarios con la métrica principal. Valor predeterminado: False
|
|
discard_no_metric
|
Si es False, los elementos secundarios sin métrica principal se anexarán a la lista. Valor predeterminado: False
|
Devoluciones
| Tipo | Description |
|---|---|
|
Lista de diccionarios con identificador de ejecución, hiperparámetros, mejor métrica principal y estado |
get_diagnostics
No debe usarse. El método get_diagnostics no se admite para la subclase HyperDriveRun.
get_diagnostics()Excepciones
| Tipo | Description |
|---|---|
get_hyperparameters
Devuelve los hiperparámetros de todas las ejecuciones secundarias que se iniciaron mediante este HyperDriveRun.
get_hyperparameters()Devoluciones
| Tipo | Description |
|---|---|
|
Hiperparámetros de todas las ejecuciones secundarias. Es un diccionario con run_id como clave. |
get_metrics
Devuelve las métricas de todas las ejecuciones iniciadas por este HyperDriveRun.
get_metrics()Devoluciones
| Tipo | Description |
|---|---|
|
Métricas de todos los elementos secundarios de esta ejecución. |
Atributos
hyperdrive_config
Devuelve la configuración de ejecución de HyperDrive.
Devoluciones
| Tipo | Description |
|---|---|
|
Configuración de ejecución de HyperDrive. |
HYPER_DRIVE_RUN_USER_AGENT
HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'RUN_TYPE
RUN_TYPE = 'hyperdrive'