AksEndpointDeploymentConfiguration Класс
Примечание
Это экспериментальный класс, который может быть изменен в любое время. Дополнительные сведения см. по адресу https://aka.ms/azuremlexperimental.
Представляет сведения о конфигурации развертывания для службы, развернутой в Службе Kubernetes Azure.
Создает объект AksEndpointDeploymentConfiguration с помощью метода deploy_configuration класса AksEndpoint.
Инициализируйте объект конфигурации для развертывания конечной точки в целевом объекте вычислений AKS.
- Наследование
-
AksEndpointDeploymentConfiguration
Конструктор
AksEndpointDeploymentConfiguration(autoscale_enabled, autoscale_min_replicas, autoscale_max_replicas, autoscale_refresh_seconds, autoscale_target_utilization, collect_model_data, auth_enabled, cpu_cores, memory_gb, enable_app_insights, scoring_timeout_ms, replica_max_concurrent_requests, max_request_wait_time, num_replicas, primary_key, secondary_key, tags, properties, description, gpu_cores, period_seconds, initial_delay_seconds, timeout_seconds, success_threshold, failure_threshold, namespace, token_auth_enabled, version_name, traffic_percentile, compute_target_name, cpu_cores_limit, memory_gb_limit)Параметры
- autoscale_enabled
- bool
Указывает, следует ли включить автомасштабирование для этой Веб-службы.
По умолчанию используется значение True, если num_replicas = None (Нет).
- autoscale_min_replicas
- int
Минимальное число контейнеров, используемых при автомасштабировании этой Веб-службы. По умолчанию равен 1.
- autoscale_max_replicas
- int
Максимальное число контейнеров, используемых при автомасштабировании этой Веб-службы. Значение по умолчанию равно 10.
- autoscale_refresh_seconds
- int
Частота, с которой должны выполняться попытки автомасштабирования этой Веб-службы. По умолчанию равен 1.
- autoscale_target_utilization
- int
Целевой объем использования, который нужно пытаться поддерживать при автомасштабировании этой Веб-службы (в процентах от 100). Значение по умолчанию — 70.
- collect_model_data
- bool
Указывает, следует ли включить сбор данных модели для этой веб-службы. Значение по умолчанию — False.
- auth_enabled
- bool
Указывает, следует ли включить проверку подлинности для этой веб-службы. Значение по умолчанию — True.
- cpu_cores
- float
Количество ядер ЦП, выделяемых для этой Веб-службы. Может выражаться десятичным числом. Значение по умолчанию — 0,1
- memory_gb
- float
Объем памяти (в ГБ), выделяемой для этого объекта WebService. Может выражаться десятичным числом. Значение по умолчанию — 0,5
- enable_app_insights
- bool
Указывает, следует ли включить ведение журнала Application Insights для этой Веб-службы. Значение по умолчанию — False.
- scoring_timeout_ms
- int
Время ожидания для вызовов оценок этой Веб-службы. Значение по умолчанию — 60000.
- replica_max_concurrent_requests
- int
Максимальное количество одновременных запросов на реплику, которое будет разрешено для этой Веб-службы. По умолчанию равен 1. Не изменяйте этот параметр со значения по умолчанию 1, если это не требует служба технической поддержки Майкрософт или член команды Машинного обучения Azure.
- max_request_wait_time
- int
Максимальный период времени (в миллисекундах), в течение которого запрос будет оставаться в очереди до возврата ошибки 503. По умолчанию: 500.
- num_replicas
- int
Количество контейнеров, выделяемых для этой Веб-службы. Значения по умолчанию нет. Если этот параметр не задан, средство автомасштабирования будет включено по умолчанию.
- secondary_key
- str
Вторичный ключ проверки подлинности, используемый для этой веб-службы.
Словарь свойств значений ключа для предоставления этой веб-службе. Эти свойства нельзя изменить после развертывания, однако можно добавить новые пары "ключ-значение".
- gpu_cores
- int
Количество ядер GPU, выделяемых для этого объекта WebService. Значение по умолчанию — 0.
- period_seconds
- int
Частота (в секундах) выполнения пробы активности. Значение по умолчанию — 10 секунд. Минимальное значение — 1.
- initial_delay_seconds
- int
Количество секунд после запуска контейнера перед инициированием пробы активности. Значение по умолчанию — 310.
- timeout_seconds
- int
Период в секундах, после которого истекает время ожидания пробы активности. Значение по умолчанию — 2 секунды. Минимальное значение — 1.
- success_threshold
- int
Минимальное число последовательных успешных попыток проведения пробы активности после сбоя, которое нужно, чтобы проба считалась успешной. По умолчанию равен 1. Минимальное значение — 1.
- failure_threshold
- int
Количество попыток (failureThreshold), выполняемых Kubernetes, до их полного прекращения в случае запуска pod, но сбоя пробы активности. Значение по умолчанию — 3. Минимальное значение — 1.
- namespace
- str
Пространство имен Kubernetes, в котором развертывается эта Веб-служба: до 63 строчных букв, цифр (a–z, 0–9) и дефисов (-). Первый и последний символы не могут быть дефисами.
- token_auth_enabled
- bool
Указывает, следует ли включить проверку подлинности Azure Active Directory для этой веб-службы. Если этот параметр включен, пользователи могут получить маркер доступа для доступа к этой веб-службе с помощью учетных данных Azure Active Directory. Значение по умолчанию — False.
- cpu_cores_limit
- float
Максимальное число ядер ЦП, которое может использовать эта веб-служба. Может выражаться десятичным числом.
- memory_gb_limit
- float
Максимальный объем памяти (в ГБ), который может использовать этот объект WebService. Может выражаться десятичным числом.
- autoscale_enabled
- bool
Указывает, следует ли включить автомасштабирование для этой Веб-службы.
По умолчанию используется значение True, если num_replicas = None (Нет).
- autoscale_min_replicas
- int
Минимальное число контейнеров, используемых при автомасштабировании этой Веб-службы. По умолчанию равен 1.
- autoscale_max_replicas
- int
Максимальное число контейнеров, используемых при автомасштабировании этой Веб-службы. Значение по умолчанию равно 10.
- autoscale_refresh_seconds
- int
Частота, с которой должны выполняться попытки автомасштабирования этой Веб-службы. По умолчанию равен 1.
- autoscale_target_utilization
- int
Целевой объем использования, который нужно пытаться поддерживать при автомасштабировании этой Веб-службы (в процентах от 100). Значение по умолчанию — 70.
- collect_model_data
- bool
Указывает, следует ли включить сбор данных модели для этой веб-службы. Значение по умолчанию — False.
- auth_enabled
- bool
Указывает, следует ли включить проверку подлинности для этой веб-службы. Значение по умолчанию — True.
- cpu_cores
- float
Количество ядер ЦП, выделяемых для этой Веб-службы. Может выражаться десятичным числом. Значение по умолчанию — 0,1
- memory_gb
- float
Объем памяти (в ГБ), выделяемой для этого объекта WebService. Может выражаться десятичным числом. Значение по умолчанию — 0,5
- enable_app_insights
- bool
Указывает, следует ли включить ведение журнала Application Insights для этой Веб-службы. Значение по умолчанию — False.
- scoring_timeout_ms
- int
Время ожидания для вызовов оценок этой Веб-службы. Значение по умолчанию — 60000.
- replica_max_concurrent_requests
- int
Максимальное количество одновременных запросов на реплику, которое будет разрешено для этой Веб-службы. По умолчанию равен 1. Не изменяйте этот параметр со значения по умолчанию 1, если это не требует служба технической поддержки Майкрософт или член команды Машинного обучения Azure.
- max_request_wait_time
- int
Максимальный период времени (в миллисекундах), в течение которого запрос будет оставаться в очереди до возврата ошибки 503. По умолчанию: 500.
- num_replicas
- int
Количество контейнеров, выделяемых для этой Веб-службы. Значения по умолчанию нет. Если этот параметр не задан, средство автомасштабирования будет включено по умолчанию.
- secondary_key
- str
Вторичный ключ проверки подлинности, используемый для этой веб-службы.
Словарь свойств значений ключа для предоставления этой веб-службе. Эти свойства нельзя изменить после развертывания, однако можно добавить новые пары "ключ-значение".
- gpu_cores
- int
Количество ядер GPU, выделяемых для этого объекта WebService. Значение по умолчанию — 0.
- period_seconds
- int
Частота (в секундах) выполнения пробы активности. Значение по умолчанию — 10 секунд. Минимальное значение — 1.
- initial_delay_seconds
- int
Количество секунд после запуска контейнера перед инициированием пробы активности. Значение по умолчанию — 310.
- timeout_seconds
- int
Период в секундах, после которого истекает время ожидания пробы активности. Значение по умолчанию — 2 секунды. Минимальное значение — 1.
- success_threshold
- int
Минимальное число последовательных успешных попыток проведения пробы активности после сбоя, которое нужно, чтобы проба считалась успешной. По умолчанию равен 1. Минимальное значение — 1.
- failure_threshold
- int
Количество попыток (failureThreshold), выполняемых Kubernetes, до их полного прекращения в случае запуска pod, но сбоя пробы активности. Значение по умолчанию — 3. Минимальное значение — 1.
- namespace
- str
Пространство имен Kubernetes, в котором развертывается эта Веб-служба: до 63 строчных букв, цифр (a–z, 0–9) и дефисов (-). Первый и последний символы не могут быть дефисами.
- token_auth_enabled
- bool
Указывает, следует ли включить проверку подлинности Azure Active Directory для этой веб-службы. Если этот параметр включен, пользователи могут получить маркер доступа для доступа к этой веб-службе с помощью учетных данных Azure Active Directory. Значение по умолчанию — False.
- compute_target_name
- str
Имя целевого объект вычислений, в который будет выполняться развертывание.
- cpu_cores_limit
- float
Максимальное число ядер ЦП, которое может использовать этот объект WebService. Может выражаться десятичным числом.
- memory_gb_limit
- float
Максимальный объем памяти (в ГБ), который может использовать этот объект WebService. Может выражаться десятичным числом.
Переменные
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_enabled
Указывает, следует ли включить автомасштабирование для этой Веб-службы. По умолчанию используется значение True, если num_replicas = None (Нет).
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_min_replicas
Минимальное число контейнеров, используемых при автомасштабировании этой Веб-службы. По умолчанию равен 1.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_max_replicas
Максимальное число контейнеров, используемых при автомасштабировании этой Веб-службы. Значение по умолчанию равно 10.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_refresh_seconds
Частота, с которой должны выполняться попытки автомасштабирования этой Веб-службы. По умолчанию равен 1.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_target_utilization
Целевой объем использования, который нужно пытаться поддерживать при автомасштабировании этой Веб-службы (в процентах от 100). Значение по умолчанию — 70.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.collect_model_data
Указывает, следует ли включить сбор данных модели для этой веб-службы. Значение по умолчанию — False.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.auth_enabled
Указывает, следует ли включить проверку подлинности для этой веб-службы. Значение по умолчанию — True.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.cpu_cores
Количество ядер ЦП, выделяемых для этой Веб-службы. Может выражаться десятичным числом. Значение по умолчанию — 0,1
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.memory_gb
Объем памяти (в ГБ), выделяемой для этого объекта WebService. Может выражаться десятичным числом. Значение по умолчанию — 0,5
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.enable_app_insights
Указывает, следует ли включить ведение журнала Application Insights для этой Веб-службы. Значение по умолчанию — False.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.scoring_timeout_ms
Время ожидания для вызовов оценок этой Веб-службы. Значение по умолчанию — 60000.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.replica_max_concurrent_requests
Максимальное количество одновременных запросов на реплику, которое будет разрешено для этой Веб-службы. По умолчанию равен 1. Не изменяйте этот параметр со значения по умолчанию 1, если это не требует служба технической поддержки Майкрософт или член команды Машинного обучения Azure.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.max_request_wait_time
Максимальный период времени (в миллисекундах), в течение которого запрос будет оставаться в очереди до возврата ошибки 503. По умолчанию: 500.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.num_replicas
Количество контейнеров, выделяемых для этой Веб-службы. Значения по умолчанию нет. Если этот параметр не задан, средство автомасштабирования будет включено по умолчанию.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.primary_key
Первичный ключ проверки подлинности, используемый для этой веб-службы.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.secondary_key
Вторичный ключ проверки подлинности, используемый для этой веб-службы.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.tags
Словарь тегов значений ключа для предоставления этой веб-службе
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.properties
Словарь свойств значений ключа для предоставления этой веб-службе. Эти свойства нельзя изменить после развертывания, однако можно добавить новые пары "ключ-значение".
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.description
Описание для предоставления этой веб-службе.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.gpu_cores
Количество ядер GPU, выделяемых для этого объекта WebService. Значение по умолчанию — 0.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.period_seconds
Частота (в секундах) выполнения пробы активности. Значение по умолчанию — 10 секунд. Минимальное значение — 1.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.initial_delay_seconds
Количество секунд после запуска контейнера перед инициированием пробы активности. Значение по умолчанию — 310.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.timeout_seconds
Период в секундах, после которого истекает время ожидания пробы активности. Значение по умолчанию — 2 секунды. Минимальное значение — 1.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.success_threshold
Минимальное число последовательных успешных попыток проведения пробы активности после сбоя, которое нужно, чтобы проба считалась успешной. По умолчанию равен 1. Минимальное значение — 1.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.failure_threshold
Количество попыток (failureThreshold), выполняемых Kubernetes, до их полного прекращения в случае запуска pod, но сбоя пробы активности. Значение по умолчанию — 3. Минимальное значение — 1.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.namespace
Пространство имен Kubernetes, в котором развертывается эта Веб-служба: до 63 строчных букв, цифр (a–z, 0–9) и дефисов (-). Первый и последний символы не могут быть дефисами.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.token_auth_enabled
Указывает, следует ли включить проверку подлинности Azure Active Directory для этой веб-службы. Если этот параметр включен, пользователи могут получить маркер доступа для доступа к этой веб-службе с помощью учетных данных Azure Active Directory. Значение по умолчанию — False.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.version_name
Имя версии в конечной точке.
- azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.traffic_percentile
Объем трафика, который получает версия в конечной точке.
Методы
| validate_endpoint_configuration |
Проверка допустимости указанных значений конфигурации. При сбое проверки будет вызвано исключение WebserviceException. |
validate_endpoint_configuration
Проверка допустимости указанных значений конфигурации.
При сбое проверки будет вызвано исключение WebserviceException.
validate_endpoint_configuration()Исключения
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по