Model Serving no Snowpark Container Services¶

Criação de um pool de computação¶

O Snowpark Container Services (SPCS) executa imagens de contêiner em pools de computação. Se você ainda não tiver um pool de computação adequado, crie um da seguinte forma:

CREATE COMPUTE POOL IF NOT EXISTS mypool
    MIN_NODES = 2
    MAX_NODES = 4
    INSTANCE_FAMILY = 'CPU_X64_M'
    AUTO_RESUME = TRUE;

Consulte a tabela de nomes de família para obter uma lista de famílias de instâncias válidas.

Certifique-se de que a função que executará o modelo seja a proprietário do pool de computação ou tenha o privilégio USAGE ou OPERATE no pool.

Criação de um repositório de imagens¶

O Snowflake Model Serving cria uma imagem de contêiner com o modelo e suas dependências. Para armazenar esta imagem, você precisa de um repositório de imagens. Se você ainda não tiver uma, crie uma da seguinte forma:

CREATE IMAGE REPOSITORY IF NOT EXISTS my_inference_images

Se você for usar um repositório de imagens que não seja seu, certifique-se de que a função que criará a imagem do contêiner tenha os privilégios READ WRITE, SERVICE READ e SERVICE WRITE no repositório. Conceda esses privilégios da seguinte forma:

GRANT READ ON IMAGE REPOSITORY my_inference_images TO ROLE myrole;
GRANT WRITE ON IMAGE REPOSITORY my_inference_images TO ROLE myrole;
GRANT SERVICE READ ON IMAGE REPOSITORY my_inference_images TO ROLE myrole;
GRANT SERVICE WRITE ON IMAGE REPOSITORY my_inference_images TO ROLE myrole;

Dependências e elegibilidade do modelo¶

As dependências de um modelo determinam se ele pode ser executado em um warehouse, em um serviço SPCS ou em ambos. É possível, se necessário, especificar dependências intencionalmente para tornar um modelo inelegível para execução em um desses ambientes.

O canal conda do Snowflake está disponível apenas em warehouses e é a única fonte de dependências de warehouse. Por padrão, as dependências do conda para modelos SPCS obtêm suas dependências do conda-forge.

Quando você registra em log uma versão do modelo, as dependências do conda do modelo são validadas em relação ao canal conda do Snowflake. Se todas as dependências do conda do modelo estiverem disponíveis, o modelo será considerado elegível para ser executado em um warehouse. Ele também pode ser elegível para executar em um serviço SPCS se todas as dependências estiverem disponíveis no conda-forge, embora isso não seja verificado até que você crie um serviço.

Modelos registrados em log com dependências PyPI devem ser executados no SPCS. Especificar pelo menos uma dependência PyPI é uma maneira de tornar um modelo inelegível para execução em um warehouse. Se seu modelo tiver apenas dependências conda, especifique pelo menos uma com um canal explícito (mesmo conda-forge), conforme mostrado no exemplo a seguir.

# reg is a snowflake.ml.registry.Registry object
reg.log_model(
    model_name="my_model",
    version_name="v1",
    model=model,
    conda_dependencies=["conda-forge::scikit-learn"])

Para modelos implementados no SPCS, as dependências do conda, se houver, são instaladas primeiro e, em seguida, todas as dependências PyPI são instaladas no ambiente conda usando pip.

Criação de um serviço¶

Para criar um serviço SPCS e implementar o modelo nele, chame o método create_service da versão do modelo, conforme mostrado no exemplo a seguir.

# mv is a snowflake.ml.model.ModelVersion object
mv.create_service(service_name="myservice",
                  service_compute_pool="my_compute_pool",
                  image_repo="mydb.myschema.my_image_repo",
                  ingress_enabled=True,
                  gpu_requests=None)

A seguir estão os argumentos necessários para create_service:

• service_name: o nome do serviço a ser criado. Este nome deve ser único dentro da conta.

• service_compute_pool: o nome do pool de computação a ser usado para executar o modelo. O pool de computação já deve existir.

• image_repo: o nome do repositório de imagens a ser usado para armazenar a imagem do contêiner. O repositório já deve existir e o usuário deve ter privilégio SERVICE WRITE nele (ou OWNERSHIP).

• ingress_enabled: se True, o serviço se torna acessível por meio de um ponto de extremidade HTTP. Para criar o ponto de extremidade, o usuário deve ter o privilégio BIND SERVICE ENDPOINT.

• gpu_requests: uma cadeia de caracteres que especifica o número de GPUs. Para um modelo que pode ser executado em CPU ou GPU, este argumento determina se o modelo será executado em CPU ou em GPUs. Se o modelo for de um tipo conhecido que só pode ser executado em CPU (por exemplo, modelos scikit-learn), a criação da imagem falhará se GPUs forem solicitadas.

Se você estiver implantando um novo modelo, pode levar 5 minutos para criar o serviço para modelos gerenciados por CPU e 10 minutos para modelos gerenciados por GPU. Se o pool de computação estiver ocioso ou precisar ser redimensionado, pode levar mais tempo para criar o serviço.

Este exemplo mostra apenas os argumentos necessários e mais comumente usados. Veja a referência da API ModelVersion para uma lista completa de argumentos.

Configuração de serviço padrão¶

O servidor de inferência usa padrões fáceis de usar que funcionam para a maioria dos casos de uso. Essas configurações são:

• Número de threads de trabalho: para um modelo alimentado por CPU, o servidor usa o dobro do número de CPUs de processos de trabalho mais um. Modelos alimentados por GPU usam um processo de trabalho. Você pode substituir isso usando o argumento num_workers na chamada create_service.

• Segurança do thread: alguns modelos não são thread-safe. Portanto, o serviço carrega uma cópia separada do modelo para cada processo de trabalho. Isso pode resultar no esgotamento de recurso para modelos grandes.

• Utilização do nó: por padrão, uma instância do servidor de inferência solicita o nó inteiro, solicitando todo o CPU e a memória do nó em que é executado. Para personalizar a alocação de recursos por instância, use argumentos como cpu_requests, memory_requests e gpu_requests.

• Ponto de extremidade: o ponto de extremidade de inferência é denominado inferência e usa a porta 5000. Eles não podem ser personalizados.

• Suspensão automática: os serviços de inferência são suspensos automaticamente após trinta minutos de inatividade, a menos que tenham um ponto de extremidade de entrada. Um serviço suspenso é retomado automaticamente quando recebe uma solicitação.

Comportamento de criação de imagem de contêiner¶

Por padrão, o Snowflake Model Serving cria a imagem do contêiner usando o mesmo pool de computação que será usado para executar o modelo. Este pool de computação de inferência provavelmente é muito poderoso para esta tarefa (por exemplo, GPUs não são usadas na criação de imagens de contêiner). Na maioria dos casos, isso não terá um impacto significativo nos custos de computação, mas se for uma preocupação, você pode escolher um pool de computação menos potente para criar imagens especificando o argumento image_build_compute_pool.

é uma função idempotente create_service. Chamá-la várias vezes não aciona a criação da imagem a cada vez. No entanto, as imagens de contêiner podem ser reconstruídas com base em atualizações no serviço de inferência, incluindo correções de vulnerabilidades em pacotes dependentes. Quando isso acontece, create_service aciona automaticamente a reconstrução da imagem

Interface de usuário¶

Você pode gerenciar os modelos implantados na Model Registry Snowsight UI. Para obter mais informações, consulte Serviços de inferência de modelos.

SQL¶

O Snowflake Model Serving cria funções de serviço ao implementar um modelo no SPCS. Essas funções servem como uma ponte de SQL para o modelo em execução no pool de computação do SPCS. Uma função de serviço é criada para cada método do modelo, e elas são nomeadas como service_name!method_name. Por exemplo, se o modelo tiver dois métodos nomeados PREDICT e EXPLAIN e estiver sendo implementado em um serviço nomeado MY_SERVICE, as funções de serviço resultantes serão MY_SERVICE!PREDICT e MY_SERVICE!EXPLAIN.

A chamada das funções de serviço de modelo em SQL é feita usando um código como o seguinte:

-- See signature of the inference function in SQL.
SHOW FUNCTIONS IN MODEL my_native_xgb_model VERSION ...;

-- Call the inference function in SQL following the same signature (from `arguments` column of the above query)
SELECT MY_SERVICE!PREDICT(feature1, feature2, ...) FROM input_data_table;

Python¶

Chame os métodos de um serviço usando o método run de um objeto de versão do modelo, incluindo o argumento service_name para especificar o serviço onde o método será executado. Por exemplo:

# Get signature of the inference function in Python
# mv is a snowflake.ml.model.ModelVersion object
mv.show_functions()
# Call the function in Python
service_prediction = mv.run(
    test_df,
    function_name="predict",
    service_name="my_service")

Se você não incluir o argumento service_name, o modelo será executado em um warehouse.

Ponto de extremidade HTTP¶

A implantação de um serviço com o ingresso ativado cria um ponto de extremidade HTTP por meio do qual você pode chamar o serviço. É possível encontrar o ponto de extremidade usando o comando SHOW ENDPOINTS IN SERVICE.

SHOW ENDPOINTS IN SERVICE my_service;

Observe que a coluna ingress_url deve se parecer com random_str-account-id.snowflakecomputing.app. Aplicam-se as limitações do nome de DNS. Em um URL, um sublinhado (_) no nome do método é substituído por um traço (-) (por exemplo, o URL de predict_proba é url/predict-proba).

Os usuários podem chamar o serviço usando o ponto de extremidade público de forma programática. Os aplicativos usam a autenticação de par de chaves para autenticar solicitações para o ponto de extremidade público. Gere um JSON Web Token (JWT) a partir do par de chaves, troque o token JWT com o Snowflake por um token OAuth e use o token OAuth para autenticar solicitações para o ponto de extremidade público de um serviço. Para obter um exemplo, consulte Acessar o ponto de extremidade público de forma programática.

Para obter mais informações sobre o formato de dados necessário, consulte Formatos de dados de entrada e saída de serviços remotos.

Consulte Como implementar um transformador de frases Hugging Face para inferência com base em GPU para um exemplo de uso de um ponto de extremidade HTTP do servidor modelo.

Suspensão de serviços¶

Se você estiver usando o serviço somente no SQL por meio de funções de serviço, não defina o parâmetro ingress_enabled como True (verdadeiro). A ativação da entrada implica que o serviço deve permanecer em execução o tempo todo para que possa responder às solicitações HTTP de entrada. Quando a entrada não está ativada, o serviço de inferência é suspenso automaticamente após trinta minutos de inatividade e é retomado automaticamente quando recebe uma solicitação.

Para suspender manualmente um serviço, use o comando ALTER SERVICE.

ALTER SERVICE my_service SUSPEND;

A retomada automática do serviço ao receber uma nova solicitação está sujeita a atrasos de programação e inicialização. O atraso no agendamento depende da disponibilidade do pool de computação, e o atraso na inicialização depende do tamanho do modelo.

Exclusão de modelos¶

É possível gerenciar modelos e versões de modelo normalmente com a interface SQL ou a API Python, com a restrição de que um modelo ou versão de modelo que esteja sendo usado por um serviço (esteja em execução ou suspenso) não pode ser descartado (excluído). Para descartar um modelo ou versão de modelo, descarte o serviço primeiro.

Como implementar um modelo XGBoost para inferência com base em CPU¶

THe código a seguir ilustra as principais chaves na implementação de um modelo XGBoost para inferência no SPCS, e depois usa o modelo implementado para inferência. Um notebook para este exemplo está disponível.

from snowflake.ml.registry import registry
from snowflake.ml.utils.connection_params import SnowflakeLoginOptions
from snowflake.snowpark import Session

from xgboost import XGBRegressor

# your model training code here output of which is a trained xgb_model

# Open model registry
reg = registry.Registry(session=session, database_name='my_registry_db', schema_name='my_registry_schema')

# Log the model in Snowflake Model Registry
model_ref = reg.log_model(
    model_name="my_xgb_forecasting_model",
    version_name="v1",
    model=xgb_model,
    conda_dependencies=["scikit-learn","xgboost"],
    sample_input_data=pandas_test_df,
    comment="XGBoost model for forecasting customer demand"
)

# Deploy the model to SPCS
model_ref.create_service(
    service_name="forecast_model_service",
    service_compute_pool="my_cpu_pool",
    image_repo="my_image_repo",
    ingress_enabled=True)

# See all services running a model
model_ref.list_services()

# Run on SPCS
model_ref.run(pandas_test_df, function_name="predict", service_name="forecast_model_service")

# Delete the service
model_ref.delete_service("forecast_model_service")

Como esse modelo tem a entrada habilitada, é possível chamar seu ponto de extremidade HTTP da seguinte forma.

import json
import numpy as np
from pprint import pprint
import requests
import snowflake.connector

# Generate headers including authorization.
# This example uses session token authorization. Ideally key-pair authentication is used for API access.
def initiate_snowflake_connection():
    connection_parameters = SnowflakeLoginOptions("connection_name")
    connection_parameters["session_parameters"] = {"PYTHON_CONNECTOR_QUERY_RESULT_FORMAT": "json"}
    snowflake_conn = snowflake.connector.connect(**connection_parameters)
    return snowflake_conn

def get_headers(snowflake_conn):
    token = snowflake_conn._rest._token_request('ISSUE')
    headers = {'Authorization': f'Snowflake Token=\"{token["data"]["sessionToken"]}\"'}
    return headers

headers = get_headers(initiate_snowflake_connection())

# Put the endpoint url with method name `predict`
# The endpoint url can be found with `show endpoints in service <service_name>`.
URL = 'https://<random_str>-<organization>-<account>.snowflakecomputing.app/predict'

# Prepare data to be sent
data = {"data": np.column_stack([range(pandas_test_df.shape[0]), pandas_test_df.values]).tolist()}

# Send over HTTP
def send_request(data: dict):
    output = requests.post(URL, json=data, headers=headers)
    assert (output.status_code == 200), f"Failed to get response from the service. Status code: {output.status_code}"
    return output.content

# Test
results = send_request(data=data)
pprint(json.loads(results))

Como implementar um transformador de frases Hugging Face para inferência com base em GPU¶

O código a seguir treina e implementa um transformador de frase Hugging Face, incluindo um ponto de extremidade HTTP.

Esse exemplo requer o pacote sentence-transformers, um pool de computação de GPU e um repositório de imagens.

from snowflake.ml.registry import registry
from snowflake.ml.utils.connection_params import SnowflakeLoginOptions
from snowflake.snowpark import Session
from sentence_transformers import SentenceTransformer

session = Session.builder.configs(SnowflakeLoginOptions("connection_name")).create()
reg = registry.Registry(session=session, database_name='my_registry_db', schema_name='my_registry_schema')

# Take an example sentence transformer from HF
embed_model = SentenceTransformer('sentence-transformers/all-MiniLM-L6-v2')

# Have some sample input data
input_data = [
    "This is the first sentence.",
    "Here's another sentence for testing.",
    "The quick brown fox jumps over the lazy dog.",
    "I love coding and programming.",
    "Machine learning is an exciting field.",
    "Python is a popular programming language.",
    "I enjoy working with data.",
    "Deep learning models are powerful.",
    "Natural language processing is fascinating.",
    "I want to improve my NLP skills.",
]

# Log the model with pip dependencies
pip_model = reg.log_model(
    embed_model,
    model_name="sentence_transformer_minilm",
    version_name="pip",
    sample_input_data=input_data,  # Needed for determining signature of the model
    pip_requirements=["sentence-transformers", "torch", "transformers"], # If you want to run this model in the Warehouse, you can use conda_dependencies instead
)

# Force Snowflake to not try to check warehouse
conda_forge_model = reg.log_model(
    embed_model,
    model_name="sentence_transformer_minilm",
    version_name="conda_forge_force",
    sample_input_data=input_data,
    # setting any package from conda-forge is sufficient to know that it can't be run in warehouse
    conda_dependencies=["sentence-transformers", "conda-forge::pytorch", "transformers"]
)

# Deploy the model to SPCS
pip_model.create_service(
    service_name="my_minilm_service",
    service_compute_pool="my_gpu_pool",  # Using GPU_NV_S - smallest GPU node that can run the model
    image_repo="my_image_repo",
    ingress_enabled=True,
    gpu_requests="1", # Model fits in GPU memory; only needed for GPU pool
    max_instances=4, # 4 instances were able to run 10M inferences from an XS warehouse
)

# See all services running a model
pip_model.list_services()

# Run on SPCS
pip_model.run(input_data, function_name="encode", service_name="my_minilm_service")

# Delete the service
pip_model.delete_service("my_minilm_service")

Em SQL, você pode chamar a função de serviço da seguinte forma:

SELECT my_minilm_service!encode('This is a test sentence.');

Você também pode chamar seu ponto de extremidade HTTP da seguinte forma.

import json
from pprint import pprint
import requests

# Put the endpoint url with method name `encode`
URL='https://<random_str>-<account>.snowflakecomputing.app/encode'

# Prepare data to be sent
data = {
    'data': []
}
for idx, x in enumerate(input_data):
    data['data'].append([idx, x])

# Send over HTTP
def send_request(data: dict):
    output = requests.post(URL, json=data, headers=headers)
    assert (output.status_code == 200), f"Failed to get response from the service. Status code: {output.status_code}"
    return output.content

# Test
results = send_request(data=data)
pprint(json.loads(results))

Como implementar um modelo PyTorch para inferência com base em GPU¶

Consulte este guia de início rápido para um exemplo de treinamento e implementação de um modelo de recomendação de aprendizado profundo PyTorch (DLRM) no SPCS para inferência com GPU.

Monitoramento das implementações SPCS¶

É possível monitorar a implementação inspecionando os serviços que estão sendo iniciados usando a seguinte consulta SQL.

SHOW SERVICES IN COMPUTE POOL my_compute_pool;

Dois trabalhos são lançados:

• MODEL_BUILD_xxxxx: Os caracteres finais do nome são randomizados para evitar conflitos de nomes. Este trabalho cria a imagem e termina depois que ela é criada. Se uma imagem já existir, o trabalho será ignorado.

  Os logs são úteis para a depuração de problemas, como conflitos nas dependências de pacotes. Para ver os logs deste trabalho, execute o SQL abaixo, certificando-se de usar os mesmos caracteres finais:

  CALL SYSTEM$GET_SERVICE_LOGS('MODEL_BUILD_xxxxx', 0, 'model-build');
  

  Copy

• MYSERVICE: O nome do serviço conforme especificado na chamada para create_service. Este trabalho é iniciado se o trabalho de MODEL_BUILD for bem-sucedido ou ignorado. Para ver os logs deste trabalho, execute o SQL abaixo:

  CALL SYSTEM$GET_SERVICE_LOGS('MYSERVICE', 0, 'model-inference');
  

  Copy

  Se os logs não estiverem disponíveis no SYSTEM$GET_SERVICE_LOG porque o trabalho ou serviço de criação foi excluído, você pode verificar a tabela de eventos (se ativada) para ver os logs:

  SELECT RESOURCE_ATTRIBUTES, VALUE
  FROM <EVENT_TABLE_NAME>
  WHERE true
      AND timestamp > dateadd(day, -1, current_timestamp())  -- choose appropriate timestamp range
      AND RESOURCE_ATTRIBUTES:"snow.database.name" = '<db of the service>'
      AND RESOURCE_ATTRIBUTES:"snow.schema.name" = '<schema of the service>'
      AND RESOURCE_ATTRIBUTES:"snow.service.name" = '<Job or Service name>'
  AND RESOURCE_ATTRIBUTES:"snow.service.container.instance" = '0'  -- choose all instances or one particular
  AND RESOURCE_ATTRIBUTES:"snow.service.container.name" != 'snowflake-ingress' --skip logs from internal sidecar
  ORDER BY timestamp ASC;
  

  Copy

Conflitos de pacotes¶

Dois sistemas determinam os pacotes instalados no contêiner de serviço: o próprio modelo e o servidor de inferência. Para minimizar os conflitos com as dependências do seu modelo, o servidor de inferência requer apenas os seguintes pacotes:

• gunicorn<24.0.0

• starlette<1.0.0

• uvicorn-standard<1.0.0

Certifique-se de que as dependências do modelo, juntamente com as dependências acima, possam ser resolvidas por pip ou conda, independentemente da que você escolher.

Se um modelo tiver conda_dependencies e pip_requirements definidos, eles serão instalados da seguinte forma via conda:

Canais:

• conda-forge

• nodefaults

Dependências:

• all_conda_packages

• pip:

  • all_pip_packages

O Snowflake obtém os pacotes Anaconda do conda-forge ao criar imagens de contêineres porque o canal conda do Snowflake está disponível apenas em warehouses, e o canal defaults exige que os usuários aceitem os termos de uso do Anaconda, o que não é possível durante uma criação automatizada. Para obter pacotes de um canal diferente, como defaults, especifique cada pacote com o nome do canal, como em defaults::pkg_name.

Serviço sem memória¶

Alguns modelos não são seguros para threads, então o Snowflake carrega uma cópia separada do modelo na memória para cada processo de trabalho. Isso pode causar condições de falta de memória para modelos grandes com um número maior de trabalhadores. Tente reduzir num_workers.

Desempenho de consulta insatisfatório¶

Normalmente, a inferência é limitada pelo número de instâncias no serviço de inferência. Tente passar um valor mais alto para max_instances ao implantar o modelo.

Não é possível alterar a especificação do serviço¶

As especificações da compilação de modelo e serviços de inferência não podem ser alteradas usando ALTER SERVICE. Somente é possível alterar atributos como TAG, MIN_INSTANCES e assim por diante. No entanto, como a imagem é publicada no repositório de imagens, você pode copiar a especificação, modificá-la e criar um novo serviço a partir dela, que pode ser iniciado manualmente.

Pacote não encontrado¶

A implementação do modelo falhou durante a fase de criação da imagem. Os logs model-build sugerem que um pacote solicitado não foi encontrado. (Essa etapa usa conda-forge por padrão se o pacote for mencionado em conda_dependencies)

A instalação do pacote pode falhar por qualquer um dos seguintes motivos:

• O nome ou a versão do pacote é inválido. Verifique a ortografia e a versão do pacote.

• A versão solicitada do pacote não existe em conda-forge. Você pode tentar remover a especificação da versão para obter a versão mais recente disponível em conda-forge ou usar pip_requirements. Você pode consultar todos os pacotes disponíveis aqui.

• Às vezes, você pode precisar de um pacote de um canal especial (por exemplo, pytorch). Adicione um prefixo channel_name:: à dependência, como pytorch::torch.

Incompatibilidade de versão do Huggingface Hub¶

Um serviço de inferência de modelo Hugging Face pode falhar com a mensagem de erro:

ImportError: huggingface-hub>=0.30.0,<1.0 is required for a normal functioning of this module, but found huggingface-hub==0.25.2

Isso ocorre porque o pacote transformers não especifica as dependências corretas do huggingface-hub, mas as verifica no código. Para resolver esse problema, registre o modelo novamente, dessa vez especificando explicitamente a versão necessária do huggingface-hub em conda_dependencies ou pip_requirements.

Torch não compilado com CUDA ativado¶

A causa típica desse erro é que você especificou conda_dependencies e pip_requirements. Conforme mencionado na seção Conflitos de pacotes, o conda é o gerenciador de pacotes usado para criar a imagem do contêiner. O Anaconda não resolve os pacotes de conda_dependencies e pip_requirements juntos e dá precedência aos pacotes do conda. Isso pode levar a uma situação em que os pacotes conda não são compatíveis com os pacotes pip. Você pode ter especificado torch no pip_requirements, e não no conda_dependencies. Considere a possibilidade de consolidar as dependências em conda_dependencies ou pip_requirements. Se isso não for possível, prefira especificar os pacotes mais importantes em conda_dependencies.