HyperDriveRun Класс

HyperDriveRun содержит сведения об отправленном эксперименте HyperDriveRun.

Этот класс можно использовать для управления, проверки состояния и получения сведений о выполнении HyperDrive и каждого из созданных дочерних выполнений.

Инициализация запуска HyperDrive.

Наследование

Run

HyperDriveRun

Конструктор

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

Параметры

Имя	Описание
experiment Обязательно	Experiment Эксперимент для выполнения HyperDrive.
run_id Обязательно	str Идентификатор выполнения HyperDrive.
hyperdrive_config	HyperDriveConfig Конфигурация для этого выполнения HyperDrive. значение по умолчанию: None
experiment Обязательно	Experiment Эксперимент для выполнения HyperDrive.
run_id Обязательно	str Идентификатор выполнения HyperDrive.
hyperdrive_config Обязательно	HyperDriveConfig Конфигурация для этого выполнения HyperDrive. Если нет, предполагается, что запуск уже существует и будет пытаться восстановить данные из облака.

Методы

cancel	Возврат значения True, если выполнение HyperDrive было успешно отменено.
fail	Не используйте. Метод Fail не поддерживается для подкласса HyperDriveRun.
get_best_run_by_primary_metric	Поиск и возврат экземпляра выполнения, который соответствует наиболее эффективному из всех дочерних выполнений. Наиболее подходящее выполнение определяется исключительно на основе параметра основной метрики, указанного в HyperDriveConfig. PrimaryMetricGoal определяет использование минимального или максимального значения основной метрики. Чтобы выполнить более подробный анализ всех метрик ExperimentRun, запускаемых этим HyperDriveRun, используйте get_metrics. Возвращается только одно из выполнений, даже если одну и ту же лучшую метрику продемонстрировали сразу несколько выполнений, запущенных этим выполнением HyperDrive.
get_children_sorted_by_primary_metric	Возврат списка дочерних элементов, отсортированных по лучшей основной метрике. Сортировка выполняется в соответствии с основной метрикой и используется со следующей целью: если задан параметр Maximize, дочерние элементы возвращаются в порядке убывания их лучшей основной метрики. Если параметр Reverse имеет значение True, используется обратный порядок. Для каждого дочернего элемента в списке результатов указан идентификатор выполнения, гиперпараметры, лучшее значение основной метрики и состояние. Дочерние элементы без основной метрики не включаются в список, если discard_no_metric имеет значение True. В противном случае они добавляются в список после дочерних элементов с основной метрикой. Обратите внимание, что параметр Reverse на них не влияет.
get_diagnostics	Не используйте. Метод get_diagnostics не поддерживается для подкласса HyperDriveRun.
get_hyperparameters	Возврат гиперпараметров для всех дочерних выполнений, которые были запущены этим HyperDriveRun.
get_metrics	Возврат метрик всех выполнений, которые были запущены этим HyperDriveRun.

cancel

Возврат значения True, если выполнение HyperDrive было успешно отменено.

cancel()

Возвращаемое значение

Тип	Описание
bool	Сведения о том, было ли успешно отменено выполнение.

fail

Не используйте. Метод Fail не поддерживается для подкласса HyperDriveRun.

fail()

Исключения

Тип	Описание
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Поиск и возврат экземпляра выполнения, который соответствует наиболее эффективному из всех дочерних выполнений.

Наиболее подходящее выполнение определяется исключительно на основе параметра основной метрики, указанного в HyperDriveConfig. PrimaryMetricGoal определяет использование минимального или максимального значения основной метрики. Чтобы выполнить более подробный анализ всех метрик ExperimentRun, запускаемых этим HyperDriveRun, используйте get_metrics. Возвращается только одно из выполнений, даже если одну и ту же лучшую метрику продемонстрировали сразу несколько выполнений, запущенных этим выполнением HyperDrive.

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

Параметры

Имя	Описание
include_failed	bool Сведения о том, следует ли включать неудачные выполнения. значение по умолчанию: True
include_canceled	bool Сведения о том, следует ли включать отмененные выполнения. значение по умолчанию: True
include_resume_from_runs	bool Сведения о том, следует ли включать наследуемые выполнения resume_from. значение по умолчанию: True

Возвращаемое значение

Тип	Описание
Run	Лучшее выполнение или None (Нет), если ни один из дочерних элементов не имеет основной метрики.

get_children_sorted_by_primary_metric

Возврат списка дочерних элементов, отсортированных по лучшей основной метрике.

Сортировка выполняется в соответствии с основной метрикой и используется со следующей целью: если задан параметр Maximize, дочерние элементы возвращаются в порядке убывания их лучшей основной метрики. Если параметр Reverse имеет значение True, используется обратный порядок.

Для каждого дочернего элемента в списке результатов указан идентификатор выполнения, гиперпараметры, лучшее значение основной метрики и состояние.

Дочерние элементы без основной метрики не включаются в список, если discard_no_metric имеет значение True. В противном случае они добавляются в список после дочерних элементов с основной метрикой. Обратите внимание, что параметр Reverse на них не влияет.

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

Параметры

Имя	Описание
top	int Число лучших дочерних элементов, которое должно быть возвращено. Если значение равно 0, будут возвращены все дочерние элементы. значение по умолчанию: 0
reverse	bool Если задано значение True, будет использован обратный порядок. Это влияет только на дочерние элементы с основной метрикой. значение по умолчанию: False
discard_no_metric	bool Если задано значение False, в список будут добавлены дочерние элементы без основной метрики. значение по умолчанию: False

Возвращаемое значение

Тип	Описание
list	Список словарей с идентификатором выполнения, гиперпараметрами, лучшей основной метрикой и состоянием

get_diagnostics

Не используйте. Метод get_diagnostics не поддерживается для подкласса HyperDriveRun.

get_diagnostics()

Исключения

Тип	Описание
HyperDriveNotImplementedException

get_hyperparameters

Возврат гиперпараметров для всех дочерних выполнений, которые были запущены этим HyperDriveRun.

get_hyperparameters()

Возвращаемое значение

Тип	Описание
dict	Гиперпараметры для всех дочерних выполнений. Это словарь, где в качестве ключа используется run_id.

get_metrics

Возврат метрик всех выполнений, которые были запущены этим HyperDriveRun.

get_metrics()

Возвращаемое значение

Тип	Описание
dict	Метрики для всех дочерних элементов этого выполнения.

Атрибуты

hyperdrive_config

Возврат конфигурации выполнения HyperDrive.

Возвращаемое значение

Тип	Описание
HyperDriveConfig	Конфигурация выполнения HyperDrive.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'