HyperDriveRun 클래스

HyperDriveRun에는 제출된 HyperDrive 실험의 세부 정보가 포함되어 있습니다.

이 클래스를 사용하여 HyperDrive 실행 및 생성된 각 자식 실행에 대한 실행 세부 정보를 관리, 확인 및 검색할 수 있습니다.

HyperDrive 실행을 초기화합니다.

생성자

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

매개 변수

Name	Description
experiment 필수	Experiment HyperDrive 실행에 대한 실험입니다.
run_id 필수	str HyperDrive 실행 ID입니다.
hyperdrive_config	HyperDriveConfig 이 HyperDrive 실행에 대한 구성입니다. Default value: None
experiment 필수	Experiment HyperDrive 실행에 대한 실험입니다.
run_id 필수	str HyperDrive 실행 ID입니다.
hyperdrive_config 필수	HyperDriveConfig 이 HyperDrive 실행에 대한 구성입니다. None인 경우 실행이 이미 존재하며 클라우드에서 수분을 공급하려고 한다고 가정합니다.

메서드

cancel	HyperDrive 실행이 성공적으로 취소된 경우 True를 반환합니다.
fail	사용하지 마세요. HyperDriveRun 하위 클래스에는 fail 메서드가 지원되지 않습니다.
get_best_run_by_primary_metric	모든 자식 실행 중에서 가장 성능이 뛰어난 실행에 해당하는 Run 인스턴스를 찾아서 반환합니다. 성능이 가장 좋은 실행은 HyperDriveConfig에 지정된 기본 메트릭 매개 변수를 기반으로만 식별됩니다. PrimaryMetricGoal은 기본 메트릭의 최소 또는 최대값이 사용되는지 여부를 제어합니다. 이 HyperDriveRun에서 시작된 모든 ExperimentRun 메트릭에 대한 자세한 분석을 수행하려면 get_metrics 사용합니다. 이 HyperDrive 실행에서 시작된 실행 중 몇 가지가 동일한 최상의 메트릭에 도달하더라도 실행 중 하나만 반환됩니다.
get_children_sorted_by_primary_metric	최상의 기본 메트릭을 기준으로 정렬된 자식 목록을 반환합니다. 정렬은 기본 메트릭 및 해당 목표에 따라 수행됩니다. 최대화되면 자식은 최상의 기본 메트릭의 내림차순으로 반환됩니다. 역방향이 True이면 순서가 반전됩니다. 결과의 각 자식에는 실행 ID, 하이퍼 매개 변수, 최상의 기본 메트릭 값 및 상태가 있습니다. 기본 메트릭이 없는 자식은 discard_no_metric True이면 삭제됩니다. 그렇지 않으면 기본 메트릭이 있는 다른 자식 뒤에 있는 목록에 추가됩니다. 역방향 옵션은 해당 옵션에 영향을 주지 않습니다.
get_diagnostics	사용하지 마세요. get_diagnostics 메서드는 HyperDriveRun 하위 클래스에 대해 지원되지 않습니다.
get_hyperparameters	이 HyperDriveRun에서 시작한 모든 자식 실행에 대한 하이퍼 매개 변수를 반환합니다.
get_metrics	이 HyperDriveRun에서 시작된 모든 실행에서 메트릭을 반환합니다.

cancel

HyperDrive 실행이 성공적으로 취소된 경우 True를 반환합니다.

cancel()

반환

형식	Description
bool	실행이 성공적으로 취소되었는지 여부입니다.

fail

사용하지 마세요. HyperDriveRun 하위 클래스에는 fail 메서드가 지원되지 않습니다.

fail()

예외

형식	Description
HyperDriveNotImplementedException

get_best_run_by_primary_metric

모든 자식 실행 중에서 가장 성능이 뛰어난 실행에 해당하는 Run 인스턴스를 찾아서 반환합니다.

성능이 가장 좋은 실행은 HyperDriveConfig에 지정된 기본 메트릭 매개 변수를 기반으로만 식별됩니다. PrimaryMetricGoal은 기본 메트릭의 최소 또는 최대값이 사용되는지 여부를 제어합니다. 이 HyperDriveRun에서 시작된 모든 ExperimentRun 메트릭에 대한 자세한 분석을 수행하려면 get_metrics 사용합니다. 이 HyperDrive 실행에서 시작된 실행 중 몇 가지가 동일한 최상의 메트릭에 도달하더라도 실행 중 하나만 반환됩니다.

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

매개 변수

Name	Description
include_failed	bool 실패한 실행을 포함할지 여부입니다. Default value: True
include_canceled	bool 취소된 실행을 포함할지 여부입니다. Default value: True
include_resume_from_runs	bool 상속된 resume_from 실행을 포함할지 여부입니다. Default value: True

반환

형식	Description
Run	최상의 실행이거나, 기본 메트릭이 있는 자식이 없으면 None입니다.

get_children_sorted_by_primary_metric

최상의 기본 메트릭을 기준으로 정렬된 자식 목록을 반환합니다.

정렬은 기본 메트릭 및 해당 목표에 따라 수행됩니다. 최대화되면 자식은 최상의 기본 메트릭의 내림차순으로 반환됩니다. 역방향이 True이면 순서가 반전됩니다.

결과의 각 자식에는 실행 ID, 하이퍼 매개 변수, 최상의 기본 메트릭 값 및 상태가 있습니다.

기본 메트릭이 없는 자식은 discard_no_metric True이면 삭제됩니다. 그렇지 않으면 기본 메트릭이 있는 다른 자식 뒤에 있는 목록에 추가됩니다. 역방향 옵션은 해당 옵션에 영향을 주지 않습니다.

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

매개 변수

Name	Description
top	int 반환할 상위 자식의 수입니다. 0이면 모든 자식이 반환됩니다. Default value: 0
reverse	bool True이면 주문이 취소됩니다. 기본 메트릭을 사용하는 어린이에게만 영향을 줍니다. Default value: False
discard_no_metric	bool False이면 기본 메트릭이 없는 자식이 목록에 추가됩니다. Default value: False

반환

형식	Description
list	실행 ID, 하이퍼 매개 변수, 최상의 기본 메트릭 및 상태가 있는 사전 목록

get_diagnostics

사용하지 마세요. get_diagnostics 메서드는 HyperDriveRun 하위 클래스에 대해 지원되지 않습니다.

get_diagnostics()

예외

형식	Description
HyperDriveNotImplementedException

get_hyperparameters

이 HyperDriveRun에서 시작한 모든 자식 실행에 대한 하이퍼 매개 변수를 반환합니다.

get_hyperparameters()

반환

형식	Description
dict	모든 자식 실행에 대한 하이퍼 매개 변수입니다. run_id 키로 사용하는 사전입니다.

get_metrics

이 HyperDriveRun에서 시작된 모든 실행에서 메트릭을 반환합니다.

get_metrics()

반환

형식	Description
dict	이 실행의 모든 자식에 대한 메트릭입니다.

특성

hyperdrive_config

하이퍼 드라이브 실행 구성을 반환합니다.

반환

형식	Description
HyperDriveConfig	하이퍼드라이브 실행 구성입니다.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'