Usar o SDK Vertex AI para Python

O SDK Vertex AI para Python ajuda a automatizar a ingestão de dados e treinar modelos para receber previsões na Vertex AI. O SDK usa o código Python para acessar a API Vertex AI, para que você possa realizar de maneira programática tudo o que puder fazer no console da Vertex AI.

Por que usar o SDK Vertex AI

O SDK é recomendado se você for um engenheiro de machine learning (ML) e de inteligência artificial (IA) experiente ou um cientista de dados que queira automatizar programaticamente seu fluxo de trabalho. O SDK da Vertex AI para Python é semelhante à biblioteca de cliente Python da Vertex AI, mas o SDK é de nível superior e menos granular. Para ver mais informações, consulte Entenda as diferenças entre o SDK e a biblioteca de cliente.

Instale o SDK da Vertex AI

A instalação do SDK Vertex AI para Python inclui as seguintes etapas:

  1. Crie um ambiente Python isolado:
  2. Instalar o pacote do SDK da Vertex AI
  3. Inicialize o SDK da Vertex AI

Crie um ambiente Python isolado:

Uma prática recomendada do Python é instalar o SDK Vertex AI em um ambiente Python isolado para cada projeto. Isso ajuda a evitar conflitos de dependência, versão e permissões. É possível criar um ambiente isolado para usar a linha de comando em um shell ou para usar um notebook.

Para criar um ambiente isolado ao usar a linha de comando, ative um ambiente venv . Depois que o ambiente venv for ativado, você poderá instalar o SDK da Vertex AI e executar os scripts do Python. Para ver mais informações, consulte Usar venv para isolar dependências e Configurar um ambiente de desenvolvimento em Python.

Para usar um notebook no ambiente isolado, crie uma instância de notebook. Depois de criar a instância de notebook, use-a para instalar o SDK Vertex AI e executar os scripts Python. Para mais informações, consulte Criar uma instância de notebooks gerenciados pelo usuário.

Instalar o pacote do SDK da Vertex AI

Para instalar o SDK da Vertex AI, execute o seguinte comando no seu ambiente virtual:

pip install google-cloud-aiplatform

Inicializar o SDK da Vertex AI

Depois de instalar o SDK da Vertex AI para Python, você precisa inicializar o SDK com os detalhes da Vertex AI e do Google Cloud. Por exemplo, ao inicializar o SDK, você especifica informações como nome, região e bucket de preparo do Cloud Storage para seu projeto. O método a seguir é um exemplo de método que inicializa o SDK da Vertex AI.

def init_sample(
    project: Optional[str] = None,
    location: Optional[str] = None,
    experiment: Optional[str] = None,
    staging_bucket: Optional[str] = None,
    credentials: Optional[auth_credentials.Credentials] = None,
    encryption_spec_key_name: Optional[str] = None,
):

    from google.cloud import aiplatform

    aiplatform.init(
        project=project,
        location=location,
        experiment=experiment,
        staging_bucket=staging_bucket,
        credentials=credentials,
        encryption_spec_key_name=encryption_spec_key_name,
    )

Escrever código com o SDK Vertex AI

Para usar o SDK da Vertex AI para Python, é necessário adicionar uma linha no seu código para importar o namespace dela. Em seguida, use a documentação de referência e as amostras de código do SDK da Vertex AI para saber mais sobre as classes, métodos e propriedades dela.

Importar o namespace do SDK da Vertex AI

O SDK da Vertex AI para Python usa o namespace google.cloud.aiplatform. Para ter acesso à funcionalidade do SDK, importe este namespace adicionando a seguinte linha ao código Python:

from google.cloud import aiplatform

Saiba mais sobre o SDK Vertex AI

O SDK do Vertex AI SDK para Python documenta a funcionalidade do SDK Vertex AI para Python. Esta referência inclui definições de classe, métodos, propriedades e tudo o que for necessário para usar o SDK Vertex AI para automatizar de maneira programática a Vertex AI. Para mais informações, consulte a referência do SDK da Vertex AI.

Teste as amostras de código e os tutoriais

Os tutoriais do notebook do Jupyter mostram como usar o SDK Vertex AI para Python como parte de um fluxo de trabalho maior. Para mais informações, consulte Tutoriais do notebook da Vertex AI.

As amostras de código no repositório GitHub do SDK Vertex AI para Python mostram como realizar tarefas individuais. Para mais informações, consulte o repositório do SDK do Vertex AI para GitHub.

Diferenças entre o SDK e a biblioteca de cliente

Quando você instala o SDK da Vertex AI para Python, a biblioteca de cliente Python da Vertex AI também é instalada. O SDK e a biblioteca de cliente da Vertex AI para Python fornecem funcionalidades semelhantes com diferentes níveis de granularidade. O SDK Vertex AI opera em um nível de abstração mais alto que o da biblioteca de cliente e é adequado para os fluxos de trabalho de ciência de dados mais comuns. Se você precisar de uma funcionalidade de nível inferior, use a biblioteca de cliente Python da Vertex AI.

O SDK Vertex AI está disponível para Python e uma biblioteca de cliente da Vertex AI está disponível para Python, Java e Node.js. Para saber como instalar a biblioteca de cliente Java ou Node.js, consulte Instalar as bibliotecas de cliente da Vertex AI. Se não houver uma biblioteca de cliente disponível na sua linguagem de programação preferida, é possível usar a API REST Vertex AI. Para mais informações, consulte a referência REST da Vertex AI.

Use a biblioteca de cliente Python da Vertex AI e o SDK juntos

Se você usar o SDK Vertex AI para Python e descobrir que precisa de mais flexibilidade ou controle ou se precisar de um método não incluído no SDK, poderá usar a biblioteca de cliente Python da Vertex AI no mesmo fluxo de trabalho. A biblioteca de cliente Python da Vertex AI usa um namespace diferente para acessar a API Vertex AI. A biblioteca de cliente e os namespaces do SDK do Python podem ser usados no mesmo script Python adicionando uma linha import para cada um no seu script Python.

Para saber mais sobre o namespace do SDK da Vertex AI, consulte Importar o namespace do SDK da Vertex AI anteriormente nesta página.

Importar o namespace da biblioteca de cliente Python da Vertex AI

O namespace da biblioteca de cliente Python da Vertex AI é google.cloud.aiplatform.gapic. Esse namespace é mapeado para o namespace google.cloud.aiplatform_v1. Esses dois namespaces podem ser usados de forma intercambiável. Para importar a biblioteca de cliente do Python, inclua uma das seguintes opções no seu script em Python: 

from google.cloud import aiplatform_gapic
from google.cloud import aiplatform_v1

A seguir