W&B ModelsでWeaveを使用する

W&B Modelsでの実験のトラッキングを、WeaveでのLLMトレースや評価とあわせて行う方法を説明するインタラクティブなノートブック。

このノートブックでは、W&B Models と Weave を組み合わせて、Retrieval-Augmented Generation (RAG) アプリケーションを構築、評価、公開するエンドツーエンドのワークフローを説明します。W&B Models Registry からファインチューニング済みのチャットモデルを取得し、Weave でトラッキングされている既存の RagModel に組み込み、weave.Evaluation で更新したアプリケーションを評価したうえで、新しい RAG モデルを Registry に公開します。このワークフローは、W&B Models でモデルをトレーニングおよびファインチューニングし、それらを Weave でトラッキングおよび評価する LLM アプリケーションに統合したい Teams を対象としています。

これはインタラクティブなノートブックです。ローカルで実行することも、以下のリンクを使用することもできます。

• Google Colabで開く
• GitHubでソースを表示

​

前提条件

まず、必須のライブラリをインストールし、APIキーを設定して、W&B にログインし、新しい W&B プロジェクトを作成します。

1. pip を使って、weave、pandas、unsloth、wandb、litellm、pydantic、torch、faiss-gpu をインストールします。

%%capture
!pip install weave wandb pandas pydantic litellm faiss-gpu
python
%%capture
!pip install unsloth
# 最新のナイトリー版 Unsloth も取得します！
!pip uninstall unsloth -y && pip install --upgrade --no-cache-dir "unsloth[colab-new] @ git+https://github.com/unslothai/unsloth.git"

2. 環境内の必須APIキーを追加します。

import os

from google.colab import userdata

os.environ["WANDB_API_KEY"] = userdata.get("WANDB_API_KEY")  # W&B Models and Weave
os.environ["OPENAI_API_KEY"] = userdata.get(
    "OPENAI_API_KEY"
)  # OpenAI - 検索用埋め込みのため
os.environ["GEMINI_API_KEY"] = userdata.get(
    "GEMINI_API_KEY"
)  # Gemini - ベースチャットモデルのため

3. W&B にログインし、新しいプロジェクトを作成します。

import pandas as pd
import wandb

import weave

wandb.login()

PROJECT = "weave-cookboook-demo"
ENTITY = "wandb-smle"

weave.init(ENTITY + "/" + PROJECT)

​

Models Registry から ChatModel をダウンロードし、UnslothLoRAChatModel を実装する

このシナリオでは、Model Team はすでに unsloth ライブラリを使用して Llama-3.2 モデルをパフォーマンス最適化向けにファインチューニングしており、このモデルは W&B Models Registry で利用できます。この step では、Registry からファインチューニング済みの ChatModel を取得し、RagModel と互換性を持たせるために weave.Model に変換します。

以下のコードで参照している RagModel は、完全な RAG アプリケーションと見なせるトップレベルの weave.Model です。これには ChatModel、ベクトルデータベース、プロンプトが含まれます。ChatModel も weave.Model であり、W&B Registry から artifact をダウンロードするコードを含んでいます。ChatModel は、RagModel の一部として他の種類の LLM チャットモデルにも対応できるよう、モジュール単位で変更できます。詳細については、Weave でモデルを表示してください。

ChatModel をロードするには、アプリに効率的にインテグレーションするために、アダプター付きの unsloth.FastLanguageModel または peft.AutoPeftModelForCausalLM を使用します。Registry からモデルをダウンロードした後、model_post_init method を使用して初期化と予測ロジックを設定します。この step に必要なコードは Registry の Use タブで利用でき、そのまま実装にコピーできます。

以下のコードは、W&B Models Registry から取得したファインチューニング済み Llama-3.2 モデルを管理、初期化、使用するための UnslothLoRAChatModel クラスを定義しています。UnslothLoRAChatModel は、最適化された推論のために unsloth.FastLanguageModel を使用します。model_post_init method はモデルをダウンロードして設定し、predict method はユーザーのクエリを処理して応答を生成します。コードをユースケースに合わせて調整するには、MODEL_REG_URL をファインチューニングしたモデルの正しい Registry パスに更新し、max_seq_length や dtype などのパラメーターをハードウェアや要件に基づいて調整してください。

from typing import Any

from pydantic import PrivateAttr
from unsloth import FastLanguageModel

import weave

class UnslothLoRAChatModel(weave.Model):
    """
    We define an extra ChatModel class to be able store and version more parameters than just the model name.
    Especially, relevant if we consider fine-tuning (locally or aaS) because of specific parameters.
    """

    chat_model: str
    cm_temperature: float
    cm_max_new_tokens: int
    cm_quantize: bool
    inference_batch_size: int
    dtype: Any
    device: str
    _model: Any = PrivateAttr()
    _tokenizer: Any = PrivateAttr()

    def model_post_init(self, __context):
        # registry の "Use" タブからそのまま貼り付けることができます
        run = wandb.init(project=PROJECT, job_type="model_download")
        artifact = run.use_artifact(f"{self.chat_model}")
        model_path = artifact.download()

        # unsloth バージョン（ネイティブで2倍高速な推論を有効化）
        self._model, self._tokenizer = FastLanguageModel.from_pretrained(
            model_name=model_path,
            max_seq_length=self.cm_max_new_tokens,
            dtype=self.dtype,
            load_in_4bit=self.cm_quantize,
        )
        FastLanguageModel.for_inference(self._model)

    @weave.op()
    async def predict(self, query: list[str]) -> dict:
        # add_generation_prompt = true - 生成時は必ず追加してください
        input_ids = self._tokenizer.apply_chat_template(
            query,
            tokenize=True,
            add_generation_prompt=True,
            return_tensors="pt",
        ).to("cuda")

        output_ids = self._model.generate(
            input_ids=input_ids,
            max_new_tokens=64,
            use_cache=True,
            temperature=1.5,
            min_p=0.1,
        )

        decoded_outputs = self._tokenizer.batch_decode(
            output_ids[0][input_ids.shape[1] :], skip_special_tokens=True
        )

        return "".join(decoded_outputs).strip()
python
MODEL_REG_URL = "wandb32/wandb-registry-RAG Chat Models/Finetuned Llama-3.2:v3"

max_seq_length = 2048  # 任意の値を指定できます！内部で RoPE Scaling を自動サポートしています！
dtype = (
    None  # 自動検出の場合は None。Tesla T4、V100 は Float16、Ampere 以降は Bfloat16
)
load_in_4bit = True  # 4bit 量子化を使用してメモリ使用量を削減します。False にすることも可能です。

new_chat_model = UnslothLoRAChatModel(
    name="UnslothLoRAChatModelRag",
    chat_model=MODEL_REG_URL,
    cm_temperature=1.0,
    cm_max_new_tokens=max_seq_length,
    cm_quantize=load_in_4bit,
    inference_batch_size=max_seq_length,
    dtype=dtype,
    device="auto",
)
python
await new_chat_model.predict(
    [{"role": "user", "content": "What is the capital of Germany?"}]
)

​

新しい ChatModel バージョンを RagModel に統合する

ファインチューニングしたチャットモデルを基に RAG アプリケーションを構築すると、パイプライン全体を作り直さなくても、用途に合わせて調整したコンポーネントを再利用できます。この step では、Weave プロジェクトから既存の RagModel を取得し、その ChatModel を更新して、ファインチューニングしたモデルを使用するようにします。新しいチャットモデルに差し替えても、ベクトルデータベースやプロンプトなどの他のコンポーネントには手を加えず、アプリケーション全体の構造を維持したままパフォーマンスを向上できます。

以下のコードは、Weave プロジェクトの参照を使用して RagModel オブジェクトを取得します。次に、RagModel の chat_model 属性を更新し、前の step で作成した新しい UnslothLoRAChatModel インスタンスを使用するようにします。その後、更新した RagModel を公開して新しいバージョンを作成します。最後に、更新した RagModel を使用してサンプルの予測クエリを実行し、新しいチャットモデルが使用されていることを確認します。

RagModel = weave.ref(
    "weave://wandb-smle/weave-cookboook-demo/object/RagModel:cqRaGKcxutBWXyM0fCGTR1Yk2mISLsNari4wlGTwERo"
).get()
python
RagModel.chat_model.chat_model
python
await RagModel.predict("When was the first conference on climate change?")
python
# MAGIC: chat_model を差し替えて新しいバージョンを公開する（他の RAG コンポーネントは気にしなくてよい）
RagModel.chat_model = new_chat_model
python
RagModel.chat_model.chat_model
python
# まず新しいバージョンを公開して、予測時に新しいバージョンを参照できるようにする
PUB_REFERENCE = weave.publish(RagModel, "RagModel")
python
await RagModel.predict("When was the first conference on climate change?")

​

weave.Evaluation を実行する

更新した RagModel を公開したら、次の step は、新たにファインチューニングしたチャットモデルがアプリケーション内で期待どおりに動作することを確認することです。この step では、既存の weave.Evaluation を使用して、更新した RagModel のパフォーマンスを評価します。このプロセスにより、新たにファインチューニングしたチャットモデルが、RAG アプリケーション内で期待どおりに動作していることを確認できます。インテグレーションを簡素化し、Models チームと Apps チームのコラボレーションを可能にするため、評価結果をモデルの W&B run と Weave Workspace の両方にログします。

In Models:

• 評価 summary は、ファインチューニング済みチャットモデルのダウンロードに使用した W&B run にログされます。これには、分析用の workspace view に表示される summary メトリクスとグラフが含まれます。
• 評価のトレース ID は run の設定に追加され、Model Team が追跡しやすいように Weave ページへ直接リンクされます。

In Weave:

• ChatModel の artifact または Registry へのリンクが、RagModel への入力として保存されます。
• W&B run ID は、コンテキストをわかりやすくするために、評価トレースの追加列として保存されます。

以下のコードは、評価オブジェクト を取得し、更新した RagModel を使用して評価を実行し、その結果を W&B と Weave の両方にログする方法を示しています。評価 reference (WEAVE_EVAL) がプロジェクトの設定と一致していることを確認してください。

# MAGIC: 評価データセットと Scorer を含む評価を取得して使用できます
WEAVE_EVAL = "weave://wandb-smle/weave-cookboook-demo/object/climate_rag_eval:ntRX6qn3Tx6w3UEVZXdhIh1BWGh7uXcQpOQnIuvnSgo"
climate_rag_eval = weave.ref(WEAVE_EVAL).get()
python
with weave.attributes({"wandb-run-id": wandb.run.id}):
    # .call 属性を使用して結果と call の両方を取得し、評価トレースを Models に保存します
    summary, call = await climate_rag_eval.evaluate.call(climate_rag_eval, RagModel)
python
# Models にログする
wandb.run.log(pd.json_normalize(summary, sep="/").to_dict(orient="records")[0])
wandb.run.config.update(
    {"weave_url": f"https://wandb.ai/wandb-smle/weave-cookboook-demo/r/call/{call.id}"}
)
wandb.run.finish()

​

新しい RAG model を Registry に保存

更新した RagModel を評価したので、最後のステップは、それを W&B Models Registry に再び公開し、他のチームが見つけて再利用できるようにすることです。更新した RagModel を Models チームと Apps チームの両方が今後使用できるようにするため、参照 artifact として W&B Models Registry にプッシュします。

以下のコードでは、更新した RagModel の weave オブジェクトのバージョンと名を取得し、それらを使用して参照リンクを作成します。続いて、このコードはモデルの Weave URL を含むメタデータを持つ新しい artifact を W&B に作成します。このコードはこの artifact を W&B Registry にログし、指定した Registry パス にリンクします。

コードを実行する前に、ENTITY 変数と PROJECT 変数がご利用の W&B 環境に合っていることを確認し、正しい対象 Registry パス を指定してください。このプロセスにより、新しい RagModel が共同作業と再利用のために W&B エコシステムへ公開され、workflow が完了します。

このセクションのコードを実行すると、更新した RagModel は参照 artifact として W&B Models Registry で利用可能になり、W&B Models と Weave の間の往復が完了します。

MODELS_OBJECT_VERSION = PUB_REFERENCE.digest  # weave オブジェクトのバージョン
MODELS_OBJECT_NAME = PUB_REFERENCE.name  # weave オブジェクト名
python
models_url = f"https://wandb.ai/{ENTITY}/{PROJECT}/weave/objects/{MODELS_OBJECT_NAME}/versions/{MODELS_OBJECT_VERSION}"
models_link = (
    f"weave://{ENTITY}/{PROJECT}/object/{MODELS_OBJECT_NAME}:{MODELS_OBJECT_VERSION}"
)

with wandb.init(project=PROJECT, entity=ENTITY) as run:
    # 新しい Artifact を作成
    artifact_model = wandb.Artifact(
        name="RagModel",
        type="model",
        description="Models Link from RagModel in Weave",
        metadata={"url": models_url},
    )
    artifact_model.add_reference(models_link, name="model", checksum=False)

    # 新しい artifact をログ
    run.log_artifact(artifact_model, aliases=[MODELS_OBJECT_VERSION])

    # registry にリンク
    run.link_artifact(
        artifact_model, target_path="wandb32/wandb-registry-RAG Models/RAG Model"
    )