create-explainability
Описание
Примечание
Объяснение доступно только для прогнозов и предикторов, сгенерированных из AutoPredictor ( CreateAutoPredictor )Создает объяснение Amazon Forecast.
Объяснение помогает лучше понять, как атрибуты в ваших данных влияют на прогноз. Amazon Forecast использует метрику под названием баллы влияния для количественной оценки относительного влияния каждого атрибута и определения, увеличивают ли они или уменьшают значения прогноза.
Чтобы включить объяснение прогноза, ваш предиктор должен включать по меньшей мере одно из следующего: связанные временные ряды, метаданные элементов или дополнительные наборы данных, такие как праздники и индекс погоды.
CreateExplainability принимает либо ARN предиктора, либо ARN прогноза. Чтобы получить агрегированные баллы влияния для всех временных рядов и временных точек в ваших наборах данных, укажите ARN предиктора. Чтобы получить баллы влияния для определённых временных рядов и временных точек, укажите ARN прогноза.
Примечание
У вас может быть только один ресурс объяснения на предиктор. Если вы уже включилиExplainPredictor в CreateAutoPredictor, у этого предиктора уже есть ресурс объяснения.Следующие параметры обязательны при указании ARN предиктора:
-
ExplainabilityName- Уникальное имя объяснения. -
ResourceArn- ARN предиктора. -
TimePointGranularity- Должно быть установлено в «ALL». -
TimeSeriesGranularity- Должно быть установлено в «ALL».
Не указывайте значение для следующих параметров:
-
DataSource- Действительно только при TimeSeriesGranularity «SPECIFIC». -
Schema- Действительно только при TimeSeriesGranularity «SPECIFIC». -
StartDateTime- Действительно только при TimePointGranularity «SPECIFIC». -
EndDateTime- Действительно только при TimePointGranularity «SPECIFIC».
Примечание
Вы можете указать максимум 50 временных рядов и 500 временных точек.Следующие параметры обязательны при указании ARN предиктора:
-
ExplainabilityName- Уникальное имя объяснения. -
ResourceArn- ARN прогноза. -
TimePointGranularity- «ALL» или «SPECIFIC». -
TimeSeriesGranularity- «ALL» или «SPECIFIC».
Если вы установите TimeSeriesGranularity в «SPECIFIC», вы также должны предоставить следующее:
-
DataSource- Местоположение S3 CSV-файла, содержащего ваши временные ряды. -
Schema- Схема определяет атрибуты и типы атрибутов, перечисленные в источнике данных.
Если вы установите TimePointGranularity в «SPECIFIC», вы также должны предоставить следующее:
-
StartDateTime- Первая метка времени в диапазоне временных точек. -
EndDateTime- Последняя метка времени в диапазоне временных точек.
См. также: Документацию API AWS
Синопсис
create-explainability
--explainability-name <value>
--resource-arn <value>
--explainability-config <value>
[--data-source <value>]
[--schema <value>]
[--enable-visualization | --no-enable-visualization]
[--start-date-time <value>]
[--end-date-time <value>]
[--tags <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]
Параметры
--explainability-name (строка)
--resource-arn (строка)
--explainability-config (структура)
Настройки конфигурации, определяющие зернистость временных рядов и временных точек для Объяснимости.
TimeSeriesGranularity -> (строка)
Для создания Объяснимости для всех временных рядов в ваших наборах данных используйте ALL. Для создания Объяснимости для определенных временных рядов в ваших наборах данных используйте SPECIFIC.
Укажите временные ряды, загрузив CSV- или Parquet-файл в Amazon S3-ведро и установив расположение в типе данных DataDestination.
TimePointGranularity -> (строка)
Для создания Объяснимости для всех временных точек в вашем горизонте прогнозирования используйте ALL. Для создания Объяснимости для определенных временных точек в вашем горизонте прогнозирования используйте SPECIFIC.
Укажите временные точки с параметрами StartDateTime и EndDateTime в операции CreateExplainability.
Сокращенная синтаксическая запись:
TimeSeriesGranularity=string,TimePointGranularity=string
Синтаксис JSON:
{
"TimeSeriesGranularity": "ALL"|"SPECIFIC",
"TimePointGranularity": "ALL"|"SPECIFIC"
}
--data-source (структура)
Источник ваших данных, роль Identity and Access Management (IAM), позволяющая Amazon Forecast получать доступ к данным, и, по желанию, ключ Key Management Service (KMS).
S3Config -> (структура)
Путь к данным, хранящимся в ведре Amazon Simple Storage Service (Amazon S3), а также учетные данные для доступа к данным.
Path -> (строка)
RoleArn -> (строка)
ARN роли Identity and Access Management (IAM), которую Amazon Forecast может использовать для доступа к ведру Amazon S3 или файлам. Если вы предоставите значение для ключа KMSKeyArn, роль должна разрешать доступ к ключу.
Передача роли между учетными записями Amazon Web Services запрещена. Если вы передадите роль, которая не находится в вашей учетной записи, вы получите ошибку InvalidInputException.
KMSKeyArn -> (строка)
Сокращенная синтаксическая запись:
S3Config={Path=string,RoleArn=string,KMSKeyArn=string}
Синтаксис JSON:
{
"S3Config": {
"Path": "string",
"RoleArn": "string",
"KMSKeyArn": "string"
}
}
--schema (структура)
Определяет поля набора данных.
Attributes -> (список)
Массив атрибутов, определяющих имя и тип каждого поля в наборе данных.
(структура)
Атрибут схемы, определяющий поле набора данных. Атрибут схемы требуется для каждого поля в наборе данных. Объект схемы содержит массив объектов SchemaAttribute.
AttributeName -> (строка)
AttributeType -> (строка)
Тип данных поля.
Для связанного набора данных временных рядов, кроме даты, item_id и атрибутов измерения прогноза, все атрибуты должны быть числового типа (целое число/вещественное число).
Сокращенная синтаксическая запись:
Attributes=[{AttributeName=string,AttributeType=string},{AttributeName=string,AttributeType=string}]
Синтаксис JSON:
{
"Attributes": [
{
"AttributeName": "string",
"AttributeType": "string"|"integer"|"float"|"timestamp"|"geolocation"
}
...
]
}
--enable-visualization | --no-enable-visualization (булево)
--start-date-time (строка)
Если TimePointGranularity установлено в значение SPECIFIC, определите первую точку для Объяснимости.
Используйте следующий формат метки времени: yyyy-MM-ddTHH:mm:ss (пример: 2015-01-01T20:00:00)
--end-date-time (строка)
Если TimePointGranularity установлено в значение SPECIFIC, определите последнюю временную точку для Объяснимости.
Используйте следующий формат метки времени: yyyy-MM-ddTHH:mm:ss (пример: 2015-01-01T20:00:00)
--tags (список)
Необязательные метаданные, которые помогут вам классифицировать и организовать ваши ресурсы. Каждый тег состоит из ключа и необязательного значения, которые вы определяете. Ключи и значения тегов чувствительны к регистру.
Применимы следующие ограничения к тегам:
- Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега должен иметь одно значение.
- Максимальное количество тегов на ресурс: 50.
- Максимальная длина ключа: 128 символов Юникода в UTF-8.
- Максимальная длина значения: 256 символов Юникода в UTF-8.
- Разрешенные символы: все буквы и цифры, пробелы, представленные в UTF-8, а также + - = . _ : / @. Если ваша схема тегов используется в других сервисах и ресурсах, также применяются ограничения по символам этих сервисов.
- Префиксы ключей не могут включать комбинацию заглавных и строчных букв
aws:илиAWS:. Значения могут иметь этот префикс. Если значение тега имеет префиксaws, но ключ этого префикса не имеет, Forecast считает его пользовательским тегом и учтет его в лимите в 50 тегов. Теги с префиксом ключаawsне учитываются в лимите тегов на ресурс. Вы не можете редактировать или удалять ключи тегов с этим префиксом.
(структура)
Необязательные метаданные, которые вы применяете к ресурсу, чтобы помочь вам классифицировать и организовать их. Каждый тег состоит из ключа и необязательного значения, которые вы определяете.
Применимы следующие основные ограничения к тегам:
- Максимальное количество тегов на ресурс - 50.
- Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
- Максимальная длина ключа - 128 символов Юникода в UTF-8.
- Максимальная длина значения - 256 символов Юникода в UTF-8.
- Если ваша схема тегов используется в нескольких сервисах и ресурсах, помните, что другие сервисы могут иметь ограничения на разрешенные символы. Обычно разрешенные символы: буквы, цифры и пробелы, представленные в UTF-8, а также следующие символы: + - = . _ : / @.
- Ключи и значения тегов чувствительны к регистру.
- Не используйте
aws:,AWS:или любые комбинации заглавных и строчных букв в качестве префикса для ключей, так как он зарезервирован для использования Amazon Web Services. Вы не можете редактировать или удалять ключи тегов с этим префиксом. Значения могут иметь этот префикс. Если значение тега имеет префиксaws, но ключ не имеет, Forecast рассматривает его как пользовательский тег и учитывает его в пределе 50 тегов. Теги только с префиксом ключаawsне учитываются в вашем лимите тегов на ресурс.
Key -> (строка)
key — это общий ярлык, который действует как категория для более конкретных значений тегов.Value -> (строка)
value действует как описание в категории тегов (ключ).Сокращенная синтаксическая запись:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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 (boolean)
Включить отладочную запись журнала.
--endpoint-url (string)
Заменить стандартный URL команды на указанный URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла учетных данных.
--region (string)
Регион для использования. Переопределяет настройки из конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (string)
Файл с корневыми сертификатами для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования для двоичных блоков. По умолчанию используется формат 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 (boolean)
Отключить вывод через кли pager.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
ExplainabilityArn -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.