Versão de acompanhamento API Referência
Visão geral
MLflow O acompanhamento de versões permite que o senhor crie representações com versões de seus aplicativos GenAI usando a entidade LoggedModel
. Esta página fornece a referência API para as versões do aplicativo de acompanhamento em MLflow.
Por que criar uma versão para seu aplicativo GenAI?
Reprodutibilidade : Capture ou vincule o código exato (por exemplo, Git commit hash) e as configurações usadas para uma versão específica, garantindo que o senhor sempre possa reconstruí-la.
depuração Regressões : Acompanhe as versões do LoggedModel
para comparar facilmente as versões problemáticas com as versões boas conhecidas, examinando as diferenças de código, configurações, resultados de avaliação e rastros.
Comparação de objetivos : Avaliar sistematicamente as versões usando o site mlflow.genai.evaluate()
para comparar métricas como pontuações de qualidade, custo e latência lado a lado.
Auditabilidade : Cada versão do LoggedModel
serve como um registro auditável, vinculado a códigos e configurações específicos para compliance e investigação de incidentes.
Conceitos principais
Modelo registrado
Um LoggedModel
no MLflow representa uma versão específica do seu aplicativo GenAI. Cada estado distinto do seu aplicativo que o senhor deseja avaliar, implantar ou consultar pode ser capturado como um novo LoggedModel
.
Características principais:
- Entidade central com controle de versão para seu aplicativo GenAI
- Captura o estado do aplicativo , incluindo configuração e parâmetros
- Links para código externo (normalmente via Git commit hash)
- Acompanha o ciclo de vida desde o desenvolvimento até a produção
Métodos de acompanhamento da versão
MLflow oferece duas abordagens para o acompanhamento da versão:
set_active_model
: Acompanhamento simples da versão que cria automaticamente umLoggedModel
, se necessário, e vincula os rastreamentos subsequentescreate_external_model
: Controle total sobre a criação de versões com extensos metadados, parâmetros e tags
Referência da API
definir_modelo_ativo
Vincula rastros a uma versão específica do LoggedModel
. Se um modelo com o nome fornecido não existir, ele criará um automaticamente.
def set_active_model(
name: Optional[str] = None,
model_id: Optional[str] = None
) -> ActiveModel:
Parâmetros
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
|
| Não* | Nome do modelo. Se o modelo não existir, cria um novo |
|
| Não* | ID de um LoggedModel existente |
* name
ou model_id
devem ser fornecidos.
Valor de retorno
Retorna um objeto ActiveModel
(subclasse de LoggedModel
) que pode ser usado como gerenciador de contexto.
Exemplo de uso
import mlflow
# Simple usage - creates model if it doesn't exist
mlflow.set_active_model(name="my-agent-v1.0")
# Use as context manager
with mlflow.set_active_model(name="my-agent-v2.0") as model:
print(f"Model ID: {model.model_id}")
# Traces within this context are linked to this model
# Use with existing model ID
mlflow.set_active_model(model_id="existing-model-id")
criar modelo_externo
Cria um novo LoggedModel
para aplicativos cujo código e artefatos são armazenados fora do MLflow (por exemplo, no Git).
def create_external_model(
name: Optional[str] = None,
source_run_id: Optional[str] = None,
tags: Optional[dict[str, str]] = None,
params: Optional[dict[str, str]] = None,
model_type: Optional[str] = None,
experiment_id: Optional[str] = None,
) -> LoggedModel:
Parâmetros
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
|
| Não | Nome do modelo. Se não for especificado, um nome aleatório será gerado |
|
| Não | ID da execução associada. padrão para a ID de execução ativa se estiver em um contexto de execução |
|
| Não | par chave-valor para organização e filtragem |
|
| Não | Parâmetros e configuração do modelo (devem ser strings) |
|
| Não | Tipo definido pelo usuário para categorização (por exemplo, " agent ", " rag-system ") |
|
| Não | Experimente se associar com. Usa experimento ativo se não for especificado |
Valor de retorno
Retorna um objeto LoggedModel
com:
model_id
: identificador exclusivo para o modeloname
: O nome do modelo atribuídoexperiment_id
: ID do experimento associadocreation_timestamp
: Quando o modelo foi criadostatus
: Status do modelo (sempre " READY " para modelos externos)tags
: Dicionário de tagsparams
: Dicionário de parâmetros
Exemplo de uso
import mlflow
# Basic usage
model = mlflow.create_external_model(
name="customer-support-agent-v1.0"
)
# With full metadata
model = mlflow.create_external_model(
name="recommendation-engine-v2.1",
model_type="rag-agent",
params={
"llm_model": "gpt-4",
"temperature": "0.7",
"max_tokens": "1000",
"retrieval_k": "5"
},
tags={
"team": "ml-platform",
"environment": "staging",
"git_commit": "abc123def"
}
)
# Within a run context
with mlflow.start_run() as run:
model = mlflow.create_external_model(
name="my-agent-v3.0",
source_run_id=run.info.run_id
)
Classe LoggedModel
A classe LoggedModel
representa um modelo com versão no MLflow.
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
|
| Identificador exclusivo para o modelo |
|
| Nome do modelo |
|
| ID do experimento associado |
|
| Tempo de criação (milissegundos desde a época) |
|
| Hora da última atualização (milissegundos desde a época) |
|
| Tipo de modelo definido pelo usuário |
|
| ID da execução que criou este modelo |
|
| Status do modelo (PRONTO, FAILED_REGISTRATION, etc.) |
|
| Dicionário de tags |
|
| Dicionário de parâmetros |
|
| URI para referenciar o modelo (por exemplo, modelos ": /model_id ") |
Padrões comuns
Acompanhamento da versão com a integração Git
import mlflow
import subprocess
# Get current git commit
git_commit = subprocess.check_output(["git", "rev-parse", "HEAD"]).decode().strip()[:8]
# Create versioned model name
model_name = f"my-app-git-{git_commit}"
# Track the version
model = mlflow.create_external_model(
name=model_name,
tags={"git_commit": git_commit}
)
Vinculando traços a versões
import mlflow
# Set active model - all subsequent traces will be linked
mlflow.set_active_model(name="my-agent-v1.0")
# Your application code with tracing
@mlflow.trace
def process_request(query: str):
# This trace will be automatically linked to my-agent-v1.0
return f"Processing: {query}"
# Run the application
result = process_request("Hello world")
Implantação de produção
Na produção, use variável de ambiente em vez de chamar set_active_model()
:
# Set the model ID that traces should be linked to
export MLFLOW_ACTIVE_MODEL_ID="my-agent-v1.0"
Melhores práticas
- Use o controle de versão semântico em nomes de modelos (por exemplo, " app-v1.2.3 ")
- Incluir o git commit nas tags para rastreabilidade
- Os parâmetros devem ser strings - converta números e booleanos
- Use model_type para categorizar aplicativos semelhantes
- Defina o modelo ativo antes do rastreamento para garantir a ligação adequada
Problemas comuns
Tipos de parâmetros inválidos :
# Error: Parameters must be strings
# Wrong:
params = {"temperature": 0.7, "max_tokens": 1000}
# Correct:
params = {"temperature": "0.7", "max_tokens": "1000"}
Próximas etapas
- Rastrear versões de aplicativos - Guia passo a passo para versionar seu aplicativo GenAI
- Vincule rastreamentos de produção - conecte dados de produção às versões do aplicativo
- pacote para implementação - aplicativos com versão implantada para o modelo de serviço