Поделиться через

AutoMLRun Класс

  • Ссылка

Представляет выполнение эксперимента автоматизированного машинного обучения в Машинном обучении Azure.

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

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

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

Конструктор

AutoMLRun(experiment, run_id, **kwargs)

Параметры

Имя Описание
experiment
Обязательно
Experiment

Эксперимент, связанный с запуском.
run_id
Обязательно
str

Идентификатор запуска.
experiment
Обязательно
Experiment

Эксперимент, связанный с запуском.
run_id
Обязательно
str

Идентификатор запуска.

Комментарии

При использовании метода submit эксперимента возвращается объект AutoMLRun.

Чтобы извлечь уже запущенное выполнение, используйте следующий код:


   from azureml.train.automl.run import AutoMLRun
   ws = Workspace.from_config()
   experiment = ws.experiments['my-experiment-name']
   automl_run = AutoMLRun(experiment, run_id = 'AutoML_9fe201fe-89fd-41cc-905f-2f41a5a98883')

Методы

cancel

Отмена запуска AutoML.

Возврат значения True, если выполнение AutoML отменено.
cancel_iteration

Отмена конкретного дочернего выполнения.
complete

Завершение выполнения AutoML.
continue_experiment

Продолжить существующий эксперимент AutoML.
fail

Сбой выполнения AutoML.

При необходимости задайте свойство Error для выполнения с сообщением или исключением, переданным в error_details.
get_best_child

Возврат дочернего элемента с наилучшим рейтингом для этого выполнения AutoML.
get_guardrails

Печать и возврат подробных результатов выполнения проверки Guardrail.
get_output

Возврат выполнения с соответствующим лучшим конвейером, который уже был проверен.

Если входные параметры не указаны, get_output возвращает оптимальный конвейер в соответствии с основной метрикой. Кроме того, можно использовать параметр iteration или metric для получения определенной итерации или наиболее подходящего выполнения для указанной метрики соответственно.
get_run_sdk_dependencies

Получение зависимостей выполнения пакета SDK для данного выполнения.
pause

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

Этот метод не реализован.
register_model

Зарегистрируйте модель в службе AzureML ACI.
resume

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

Этот метод не реализован.
retry

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

Этот метод не реализован.
summary

Получение таблицы, содержащей сводку предпринятых алгоритмов и их оценки.
wait_for_completion

Ожидает завершения этого запуска.

Возвращает объект состояния после ожидания.

cancel

Отмена запуска AutoML.

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

cancel()

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

Тип Описание

None

cancel_iteration

Отмена конкретного дочернего выполнения.

cancel_iteration(iteration)

Параметры

Имя Описание
iteration
Обязательно
int

Итерация для отмены.

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

Тип Описание

None

complete

Завершение выполнения AutoML.

complete(**kwargs)

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

Тип Описание

None

continue_experiment

Продолжить существующий эксперимент AutoML.

continue_experiment(X=None, y=None, sample_weight=None, X_valid=None, y_valid=None, sample_weight_valid=None, data=None, label=None, columns=None, cv_splits_indices=None, spark_context=None, experiment_timeout_hours=None, experiment_exit_score=None, iterations=None, show_output=False, training_data=None, validation_data=None, **kwargs)

Параметры

Имя Описание
X
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>

Обучающие функции.

Default value: None
y
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>

Обучающие метки.

Default value: None
sample_weight
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>

Выборка весов для обучающих данных.

Default value: None
X_valid
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>

Функции проверки.

Default value: None
y_valid
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>

Метки проверки.

Default value: None
sample_weight_valid
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>

Веса выборок набора для проверки.

Default value: None
data
DataFrame

Обучающие функции и метки.

Default value: None
label
str

Столбец меток в данных.

Default value: None
columns
list(str)

Список разрешенных столбцов данных для использования в качестве функций.

Default value: None
cv_splits_indices
ndarray

Индексы, по которым разбиваются обучающие данные для перекрестной проверки. Каждая строка является отдельным проходом перекрестной проверки, и в каждом проходе предоставляется два массива — первый с индексами для выборок, используемых для обучающих данных, а второй — с индексами, которые используются для данных проверки. Т. е. [[t1, v1], [t2, v2], ...], где t1 — это индексы обучения для первого прохода перекрестной проверки, а v1 — это индексы проверки для первого прохода.

Default value: None
spark_context
<xref:SparkContext>

Контекст Spark, применимый лишь при использовании в среде Azure Databricks или Spark.

Default value: None
experiment_timeout_hours
float

Количество дополнительных часов для выполнения этого эксперимента.

Default value: None
experiment_exit_score
int

Если задано значение, это означает, что эксперимент завершается при достижении этого значения.

Default value: None
iterations
int

Количество дополнительных итераций, выполняемых для этого эксперимента.

Default value: None
show_output
bool

Флаг, указывающий, выводить ли выходные данные в консоли.

Default value: False
training_data
<xref:azureml.dataprep.Dataflow> или DataFrame

Входные данные для обучения.

Default value: None
validation_data
<xref:azureml.dataprep.Dataflow> или DataFrame

Данные для проверки.

Default value: None

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

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

Родительское выполнение AutoML.

Исключения

Тип Описание
ConfigException
InvalidRunState

fail

Сбой выполнения AutoML.

При необходимости задайте свойство Error для выполнения с сообщением или исключением, переданным в error_details.

fail(error_details=None, error_code=None, _set_status=True, **kwargs)

Параметры

Имя Описание
error_details
str или BaseException

Необязательные сведения об ошибке.

Default value: None
error_code
str

Необязательный код ошибки для классификации ошибок.

Default value: None
_set_status
bool

Указывает, следует ли отправить событие состояния для отслеживания.

Default value: True

get_best_child

Возврат дочернего элемента с наилучшим рейтингом для этого выполнения AutoML.

get_best_child(metric: str | None = None, onnx_compatible: bool = False, **kwargs: Any) -> Run

Параметры

Имя Описание
metric
str

Метрика, используемая при выборе наилучшего выполнения для возврата. По умолчанию используется основная метрика.

Default value: None
onnx_compatible

Следует ли возвращать только те запуски, которые создали модели ONNX.

Default value: False
kwargs
Обязательно

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

Тип Описание

Дочернее выполнение AutoML.

get_guardrails

Печать и возврат подробных результатов выполнения проверки Guardrail.

get_guardrails(to_console: bool = True) -> Dict[str, Any]

Параметры

Имя Описание
to_console
bool

Указывает, следует ли записывать результаты проверки в консоль.

Default value: True

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

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

Словарь результатов проверки.

Исключения

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

get_output

Возврат выполнения с соответствующим лучшим конвейером, который уже был проверен.

Если входные параметры не указаны, get_output возвращает оптимальный конвейер в соответствии с основной метрикой. Кроме того, можно использовать параметр iteration или metric для получения определенной итерации или наиболее подходящего выполнения для указанной метрики соответственно.

get_output(iteration: int | None = None, metric: str | None = None, return_onnx_model: bool = False, return_split_onnx_model: SplitOnnxModelName | None = None, **kwargs: Any) -> Tuple[Run, Any]

Параметры

Имя Описание
iteration
int

Номер итерации соответствующей модели выполнения и назначения, которую необходимо вернуть.

Default value: None
metric
str

Метрика, используемая при выборе наилучшего выполнения для возврата.

Default value: None
return_onnx_model
bool

Этот метод возвратит преобразованную модель ONNX, если для параметра enable_onnx_compatible_models было задано значение True в объекте AutoMLConfig.

Default value: False
return_split_onnx_model
SplitOnnxModelName

Тип возвращаемой модели разделения ONNX

Default value: None

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

Тип Описание
Run, <xref:Model>

Выполнение, соответствующая модель с заданным назначением.

Исключения

Тип Описание
ConfigException
OnnxConvertException
NotFoundException

Комментарии

Если вы хотите проверить используемые препроцессоры и алгоритм (оценщик), то это можно сделать с помощью Model.steps, аналогично sklearn.pipeline.Pipeline.steps. Например, в приведенном ниже коде показано, как получить оценщик.


   best_run, model = parent_run.get_output()
   estimator = model.steps[-1]

get_run_sdk_dependencies

Получение зависимостей выполнения пакета SDK для данного выполнения.

get_run_sdk_dependencies(iteration=None, check_versions=True, **kwargs)

Параметры

Имя Описание
iteration
int

Номер итерации подходящего выполнения, которое необходимо извлечь. Если значение — None, извлекает родительскую среду.

Default value: None
check_versions
bool

Если значение — True, проверяет версии с текущей средой. Если значение — False, пропускает.

Default value: True

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

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

Словарь зависимостей, полученных из RunHistory.

Исключения

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

pause

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

Этот метод не реализован.

pause()

Исключения

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

register_model

Зарегистрируйте модель в службе AzureML ACI.

register_model(model_name=None, description=None, tags=None, iteration=None, metric=None)

Параметры

Имя Описание
model_name
str

Имя развертываемой модели.

Default value: None
description
str

Описание для развертываемой модели.

Default value: None
tags
dict

Метки для развертываемой модели.

Default value: None
iteration
int

Переопределение, для какой модели необходимо развертывание. Развертывает модель для данной итерации.

Default value: None
metric
str

Переопределение, для какой модели необходимо развертывание. Развертывает наилучшую модель для другой метрики.

Default value: None

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

Тип Описание
<xref:Model>

Объект зарегистрированной модели.

resume

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

Этот метод не реализован.

resume()

Исключения

Тип Описание
NotImplementedError:

retry

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

Этот метод не реализован.

retry()

Исключения

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

summary

Получение таблицы, содержащей сводку предпринятых алгоритмов и их оценки.

summary()

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

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

Pandas DataFrame, содержащий статистику модели AutoML.

wait_for_completion

Ожидает завершения этого запуска.

Возвращает объект состояния после ожидания.

wait_for_completion(show_output=False, wait_post_processing=False)

Параметры

Имя Описание
show_output
bool

Указывает, следует ли отображать выходные данные выполнения в sys.stdout.

Default value: False
wait_post_processing
bool

Указывает, следует ли дождаться завершения постобработки после завершения выполнения.

Default value: False

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

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

Объект состояния.

Исключения

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

Атрибуты

run_id

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

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

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

Идентификатор выполнения текущего выполнения.