AutoMLRun Класс

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

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

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

Наследование
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>
значение по умолчанию: None

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

y
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>
значение по умолчанию: None

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

sample_weight
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>
значение по умолчанию: None

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

X_valid
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>
значение по умолчанию: None

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

y_valid
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>
значение по умолчанию: None

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

sample_weight_valid
DataFrame или ndarray или <xref:azureml.dataprep.Dataflow>
значение по умолчанию: None

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

data
DataFrame
значение по умолчанию: None

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

label
str
значение по умолчанию: None

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

columns
list(str)
значение по умолчанию: None

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

cv_splits_indices
ndarray
значение по умолчанию: None

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

spark_context
<xref:SparkContext>
значение по умолчанию: None

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

experiment_timeout_hours
float
значение по умолчанию: None

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

experiment_exit_score
int
значение по умолчанию: None

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

iterations
int
значение по умолчанию: None

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

show_output
bool
значение по умолчанию: False

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

training_data
<xref:azureml.dataprep.Dataflow> или DataFrame
значение по умолчанию: None

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

validation_data
<xref:azureml.dataprep.Dataflow> или DataFrame
значение по умолчанию: None

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

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

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

Возвращаемый тип

Исключения

fail

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

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

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

Параметры

error_details
str или BaseException
значение по умолчанию: None

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

error_code
str
значение по умолчанию: None

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

_set_status
bool
значение по умолчанию: True

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

get_best_child

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

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

Параметры

metric
str
значение по умолчанию: None

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

onnx_compatible
значение по умолчанию: False

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

kwargs
Обязательно

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

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

get_guardrails

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

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

Параметры

to_console
bool
значение по умолчанию: True

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

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

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

Возвращаемый тип

Исключения

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
значение по умолчанию: None

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

metric
str
значение по умолчанию: None

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

return_onnx_model
bool
значение по умолчанию: False

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

return_split_onnx_model
SplitOnnxModelName
значение по умолчанию: None

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

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

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

Возвращаемый тип

Run, <xref:Model>

Исключения

Комментарии

Если вы хотите проверить используемые препроцессоры и алгоритм (оценщик), то это можно сделать с помощью 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

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

check_versions
bool
значение по умолчанию: True

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

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

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

Возвращаемый тип

Исключения

pause

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

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

pause()

Исключения

register_model

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

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

Параметры

model_name
str
значение по умолчанию: None

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

description
str
значение по умолчанию: None

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

tags
dict
значение по умолчанию: None

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

iteration
int
значение по умолчанию: None

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

metric
str
значение по умолчанию: None

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

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

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

Возвращаемый тип

<xref:Model>

resume

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

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

resume()

Исключения

NotImplementedError:

retry

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

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

retry()

Исключения

summary

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

summary()

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

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

Возвращаемый тип

wait_for_completion

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

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

wait_for_completion(show_output=False, wait_post_processing=False)

Параметры

show_output
bool
значение по умолчанию: False

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

wait_post_processing
bool
значение по умолчанию: False

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

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

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

Возвращаемый тип

Исключения

Атрибуты

run_id

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

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

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

Возвращаемый тип

str