Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

describe-predictor

Описание

Примечание

Данная операция допустима только для устаревших предикторов, созданных с помощью CreatePredictor. Если вы не используете устаревший предиктор, используйте DescribeAutoPredictor.

Описывает предиктор, созданный с помощью операции CreatePredictor.

В дополнение к перечислению свойств, предоставленных в запросе CreatePredictor, эта операция перечисляет следующие свойства:

  • DatasetImportJobArns - Задачи импорта наборов данных, используемые для импорта обучающих данных.
  • AutoMLAlgorithmArns - Если используется AutoML, алгоритмы, которые были оценены.
  • CreationTime
  • LastModificationTime
  • Status
  • Message - Если произошла ошибка, информация об ошибке.

См. также: Документацию API AWS

Синтаксис

  describe-predictor
--predictor-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--predictor-arn (строка)

Amazon Resource Name (ARN) предиктора, о котором требуется информация.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого соединения SSL AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из вашего файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет рассматриваться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для заданной настройки cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод AWS CLI.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры входных данных CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров входных данных CLI.

Вывод

PredictorArn -> (строка)

Уникальный идентификатор (ARN) предиктора.

PredictorName -> (строка)

Имя предиктора.

AlgorithmArn -> (строка)

Amazon Resource Name (ARN) алгоритма, используемого для обучения модели.

AutoMLAlgorithmArns -> (список)

Когда PerformAutoML указано, ARN выбранного алгоритма.

(строка)

ForecastHorizon -> (целое число)

Количество временных шагов прогноза. Горизонт прогноза также называется длиной прогноза.

ForecastTypes -> (список)

Типы прогнозов, используемые во время обучения предиктора. Значение по умолчанию — ["0.1","0.5","0.9"]

(строка)

PerformAutoML -> (булево)

Указывает, выполняется ли для предиктора АвтоML.

AutoMLOverrideStrategy -> (строка)

Примечание

Стратегия LatencyOptimized переопределения АвтоML доступна только в закрытой бета-версии. Обратитесь в службу поддержки Amazon Web Services или своему менеджеру по счёту для получения информации об условиях доступа.

Стратегия АвтоML, используемая для обучения предиктора. Если LatencyOptimized не указано, стратегия АвтоML оптимизирует точность предиктора.

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

PerformHPO -> (булево)

Указывает, выполняется ли для предиктора оптимизация гиперпараметров (HPO).

TrainingParameters -> (отображение)

Параметры обучения по умолчанию или переопределения, выбранные во время обучения модели. При использовании АвтоML или выборе HPO с CNN-QR или DeepAR+ возвращаются оптимизированные значения выбранных гиперпараметров. Дополнительную информацию можно найти в aws-forecast-choosing-recipes .

ключ -> (строка)

значение -> (строка)

EvaluationParameters -> (структура)

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

NumberOfBacktestWindows -> (целое число)

Количество разбиений входных данных. По умолчанию 1. Допустимые значения от 1 до 5.

BackTestWindowOffset -> (целое число)

Точка от конца набора данных, где необходимо разделить данные для обучения и тестирования модели (оценки). Укажите значение в виде количества точек данных. По умолчанию равно значению горизонта прогноза. BackTestWindowOffset может быть использовано для имитации виртуальной даты начала прогноза в прошлом. Это значение должно быть больше или равно горизонту прогноза и меньше половины длины набора данных TARGET_TIME_SERIES.

ForecastHorizon <= BackTestWindowOffset < 1/2 * длины набора данных TARGET_TIME_SERIES

HPOConfig -> (структура)

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

ParameterRanges -> (структура)

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

CategoricalParameterRanges -> (список)

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

(структура)

Определяет категориальный гиперпараметр и диапазон настраиваемых значений. Этот объект является частью объекта ParameterRanges.

Name -> (строка)

Имя настраиваемого категориального гиперпараметра.

Values -> (список)

Список настраиваемых категорий для гиперпараметра.

(строка)

ContinuousParameterRanges -> (список)

Определяет диапазон настраиваемых значений для каждого непрерывного гиперпараметра.

(структура)

Определяет непрерывный гиперпараметр и диапазон настраиваемых значений. Этот объект является частью объекта ParameterRanges.

Name -> (строка)

Имя настраиваемого гиперпараметра.

MaxValue -> (вещественное число)

Максимальное настраиваемое значение гиперпараметра.

MinValue -> (вещественное число)

Минимальное настраиваемое значение гиперпараметра.

ScalingType -> (строка)

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

Auto

Amazon Forecast выбирает наилучший масштаб для гиперпараметра.

Линейный

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

Логарифмический

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

Логарифмический масштаб работает только для диапазонов, содержащих значения больше 0.

Обратный логарифмический

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

Обратный логарифмический масштаб работает только для диапазонов, полностью находящихся в диапазоне 0 <= x < 1.0.

Дополнительную информацию о выборе масштаба гиперпараметров см. в разделе Масштабирование гиперпараметров . Одно из следующих значений:

IntegerParameterRanges -> (список)

Определяет диапазон настраиваемых значений для каждого целочисленного гиперпараметра.

(структура)

Определяет целочисленный гиперпараметр и диапазон настраиваемых значений. Этот объект является частью объекта ParameterRanges.

Name -> (строка)

Имя настраиваемого гиперпараметра.

MaxValue -> (целое число)

Максимальное настраиваемое значение гиперпараметра.

MinValue -> (целое число)

Минимальное настраиваемое значение гиперпараметра.

ScalingType -> (строка)

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

Auto

Amazon Forecast выбирает наилучший масштаб для гиперпараметра.

Линейный

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

Логарифмический

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

Логарифмический масштаб работает только для диапазонов, содержащих значения больше 0.

Обратный логарифмический

Не поддерживается для IntegerParameterRange .

Обратный логарифмический масштаб работает только для диапазонов, полностью находящихся в диапазоне 0 <= x < 1.0.

Дополнительную информацию о выборе масштаба гиперпараметров см. в разделе Масштабирование гиперпараметров . Одно из следующих значений:

InputDataConfig -> (структура)

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

DatasetGroupArn -> (строка)

Amazon Resource Name (ARN) группы наборов данных.

SupplementaryFeatures -> (список)

Массив дополнительных функций. Единственная поддерживаемая функция — календарь праздников.

(структура)

Примечание

Этот объект относится к операции CreatePredictor. Если вы создали предиктор с помощью CreateAutoPredictor, см. AdditionalDataset.

Описывает дополнительную функцию группы наборов данных. Этот объект является частью объекта InputDataConfig. Amazon Forecast поддерживает встроенные функции «Индекс погоды» и «Праздники».

Индекс погоды

Индекс погоды Amazon Forecast — это встроенная функция, которая включает исторические и прогнозируемые данные о погоде в вашу модель. Индекс погоды дополняет ваши наборы данных более чем двумя годами исторических данных о погоде и до 14 дней прогнозируемых данных о погоде. Дополнительную информацию см. в разделе Индекс погоды Amazon Forecast.

Праздники

Праздники — это встроенная функция, которая включает в вашу модель обработанный набор данных с информацией о национальных праздниках. Она обеспечивает поддержку календарей праздников 66 стран. Для просмотра календарей праздников обратитесь к библиотеке Jollyday. Дополнительную информацию см. в разделе Функция праздников.

Name -> (строка)

Имя функции. Допустимые значения: "holiday" и "weather".

Value -> (строка)

Индекс погоды

Для включения Индекса погоды задайте значение "true".

Праздники

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

  • “AL” - АЛБАНИЯ
  • “AR” - АРГЕНТИНА
  • …

FeaturizationConfig -> (структура)

Настройка функций.

ForecastFrequency -> (строка)

Частота прогнозов в прогнозе.

Допустимые интервалы — целое число, за которым следует Y (год), M (месяц), W (неделя), D (день), H (час) и мин (минута). Например, «1D» означает каждый день, а «15мин» — каждые 15 минут. Нельзя указать значение, которое бы перекрывалось с частотой следующего более крупного интервала. Это означает, например, что нельзя указать частоту 60 минут, поскольку это эквивалентно 1 часу. Допустимые значения для каждой частоты следующие:

  • Минута - 1-59
  • Час - 1-23
  • День - 1-6
  • Неделя - 1-4
  • Месяц - 1-11
  • Год - 1

Таким образом, если вам нужны прогнозы каждые две недели, укажите «2W». Или, если вам нужны квартальные прогнозы, укажите «3M».

Частота должна быть больше или равна частоте набора данных TARGET_TIME_SERIES.

При предоставлении набора данных RELATED_TIME_SERIES частота должна быть равна частоте набора данных TARGET_TIME_SERIES.

ForecastDimensions -> (список)

Массив имён полей (измерений), определяющих, как сгруппировать генерируемый прогноз.

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

Все измерения прогноза, указанные в наборе данных TARGET_TIME_SERIES, не нужно указывать в запросе CreatePredictor. Все измерения прогноза, указанные в наборе данных RELATED_TIME_SERIES, должны быть указаны в запросе CreatePredictor.

(строка)

Featurizations -> (список)

Массив информации о функциях (преобразованиях) для полей набора данных.

(структура)

Примечание

Этот объект относится к операции CreatePredictor. Если вы создали свой предиктор с помощью CreateAutoPredictor, см. AttributeConfig.

Предоставляет информацию о функциях (преобразованиях) для поля набора данных. Этот объект является частью объекта FeaturizationConfig.

Например:

{

"AttributeName": "demand",

FeaturizationPipeline [ {

"FeaturizationMethodName": "filling",

"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}

} ]

}

AttributeName -> (строка)

Имя атрибута схемы, определяющего поле данных, которое необходимо преобразовать в функции. Amazon Forecast поддерживает целевое поле наборов данных TARGET_TIME_SERIES и RELATED_TIME_SERIES. Например, для домена RETAIL целевое поле — demand, а для домена CUSTOM — target_value. Для получения дополнительной информации см. howitworks-missing-values.

FeaturizationPipeline -> (список)

Массив по одному объекту FeaturizationMethod, определяющему метод преобразования функций.

(структура)

Предоставляет информацию о методе, который преобразует (преобразует) поле набора данных в функции. Метод является частью объекта FeaturizationPipeline объекта Featurization.

Ниже приведён пример того, как указать объект FeaturizationMethod.

{

"FeaturizationMethodName": "filling",

"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}

}

FeaturizationMethodName -> (строка)

Имя метода. Поддерживается только метод «заполнение».

FeaturizationMethodParameters -> (карта)

Параметры метода (пары ключ-значение), которые представляют собой карту параметров переопределения. Укажите эти параметры, чтобы переопределить значения по умолчанию. Атрибуты временных рядов, связанных с другими, не принимают параметры агрегации.

Следующий список показывает параметры и их допустимые значения для метода «заполнение» функции для набора данных Целевой временной ряд. Жирным шрифтом выделено значение по умолчанию.

  • aggregation : sum , avg , first , min , max
  • frontfill : none
  • middlefill : zero , nan (не число), value , median , mean , min , max
  • backfill : zero , nan , value , median , mean , min , max

Следующий список показывает параметры и их допустимые значения для метода функции Связанного временного ряда (значений по умолчанию нет):

  • middlefill : zero , value , median , mean , min , max
  • backfill : zero , value , median , mean , min , max
  • futurefill : zero , value , median , mean , min , max

Чтобы установить метод заполнения на определённое значение, установите параметр fill на value и определите значение в соответствующем параметре _value. Например, чтобы установить обратное заполнение на значение 2, включите следующее: "backfill": "value" и "backfill_value":"2".

ключ -> (строка)

значение -> (строка)

EncryptionConfig -> (структура)

Ключ службы управления ключами (KMS) и роль управления доступом и идентификацией (IAM), которую может принять Amazon Forecast для доступа к ключу.

RoleArn -> (строка)

ARN роли IAM, которую Amazon Forecast может принять для доступа к ключу KMS.

Передача роли между учётными записями Amazon Web Services запрещена. Если вы передадите роль, которая не находится в вашей учётной записи, будет возвращена ошибка InvalidInputException.

KMSKeyArn -> (строка)

Amazon Resource Name (ARN) ключа KMS.

PredictorExecutionDetails -> (структура)

Информация о состоянии и результатах обратных тестов, выполненных для оценки точности предиктора. Вы указываете количество обратных тестов при вызове операции.

PredictorExecutions -> (список)

Массив обратных тестов, выполненных для оценки точности предиктора по определённому алгоритму. Число окон в массиве определяется значением NumberOfBacktestWindows объекта.

(структура)

Алгоритм, используемый для выполнения обратного теста, и состояние этих тестов.

AlgorithmArn -> (строка)

ARN алгоритма, использованного для тестирования предиктора.

TestWindows -> (список)

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

(структура)

Состояние, время начала и окончания обратного теста, а также причина сбоя, если применимо.

TestWindowStart -> (временная метка)

Время начала теста.

TestWindowEnd -> (временная метка)

Время окончания теста.

Status -> (строка)

Состояние теста. Возможные состояния:

  • ACTIVE
  • CREATE_IN_PROGRESS
  • CREATE_FAILED

Message -> (строка)

Если тест завершился сбоем, причина сбоя.

EstimatedTimeRemainingInMinutes -> (целое число)

Ожидаемое время выполнения задания обучения предиктора в минутах.

IsAutoPredictor -> (булево)

Создан ли предиктор с помощью CreateAutoPredictor.

DatasetImportJobArns -> (список)

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

(строка)

Status -> (строка)

Состояние предиктора. Состояния включают:

  • ACTIVE
  • CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
  • DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
  • CREATE_STOPPING , CREATE_STOPPED

Примечание

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

Message -> (строка)

Если произошла ошибка, информационное сообщение об ошибке.

CreationTime -> (временная метка)

Время создания задачи обучения модели.

LastModificationTime -> (временная метка)

Последнее время изменения ресурса. Временная метка зависит от состояния задачи:

  • CREATE_PENDING - CreationTime.
  • CREATE_IN_PROGRESS - Текущая временная метка.
  • CREATE_STOPPING - Текущая временная метка.
  • CREATE_STOPPED - Время остановки задачи.
  • ACTIVE или CREATE_FAILED - Время завершения или завершения задачи с ошибкой.

OptimizationMetric -> (строка)

Метрика точности, используемая для оптимизации предиктора.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API