Call の表示名を設定する

W&B Weave のトレースで Call の表示名を設定または上書きする

Op は Call を生成します。Op は、@weave.op でデコレートした関数または method です。デフォルトでは、Op の名は関数名になり、関連付けられた Call も同じ表示名になります。

custom 表示名を使うと、Weave UI で Call を識別しやすくなります。同じ Op の Call を区別したり、入力値やタイムスタンプなどの動的なコンテキストを表示したり、Call 名をチームの規約に合わせたりするために使用します。

特定の Op に属するすべての Call の表示名は、いくつかの方法で上書きできます。必要な scope に合った方法を選択してください。単一の Call に適用することも、Op のすべての Call に適用することも、Op 自体に適用することもできます。

Python

1. Op の呼び出し時に表示名を変更します。次の例では、__weave 辞書を使用して、Op の表示名より優先される Call の表示名を設定します。

result = my_function("World", __weave={"display_name": "My Custom Display Name"})

2. Call ごとに表示名を変更します。次の例では、Op.call method を使用して call オブジェクトを返します。その後、そのオブジェクトを使用して call.set_display_name で表示名を設定できます。

result, call = my_function.call("World")
call.set_display_name("My Custom Display Name")

3. 特定の Op に属するすべての Call の表示名を変更します。次の例では、@weave.op 関数デコレータ自体で新しい表示名を設定し、その Op のすべての Call に反映させます。

@weave.op(call_display_name="My Custom Display Name")
def my_function(name: str):
    return f"Hello, {name}!"

call_display_name には、call オブジェクトを受け取り文字列を返す関数も指定できます。関数の実行時に Weave が call オブジェクトを自動的に渡します。これを使って、関数名、Call の inputs、フィールドなどに基づいて動的に名を生成できます。これは、各 Call の名に実行時のコンテキストを反映させたい場合に便利です。

よくあるユースケースの 1 つは、関数名に Timestamp を付けることです。

from datetime import datetime

@weave.op(call_display_name=lambda call: f"{call.func_name}__{datetime.now()}")
def func():
    return ...

.attributes を使って custom メタデータをログすることもできます。

def custom_attribute_name(call):
    model = call.attributes["model"]
    revision = call.attributes["revision"]
    now = call.attributes["date"]

    return f"{model}__{revision}__{now}"

@weave.op(call_display_name=custom_attribute_name)
def func():
    return ...

with weave.attributes(
    {
        "model": "finetuned-llama-3.1-8b",
        "revision": "v0.1.2",
        "date": "2024-08-01",
    }
):
    func()  # 表示名は "finetuned-llama-3.1-8b__v0.1.2__2024-08-01" になります

    with weave.attributes(
        {
            "model": "finetuned-gpt-4o",
            "revision": "v0.1.3",
            "date": "2024-08-02",
        }
    ):
        func()  # 表示名は "finetuned-gpt-4o__v0.1.3__2024-08-02" になります

4. Op 自体の表示名を変更します。Op に関連付けられた Call は同じ表示名を持つため、Op の名を変更することは、それが生成するすべての Call の名を変更する最も直接的な方法です。Op 自体の名を上書きすると、Call の表示名も変わります。これを行う方法は 2 つあります。

   • Call をログする前に Op の name プロパティを設定します:

     my_function.name = "My Custom Op Name"
     

   • Op デコレータで name オプションを設定します:

     @weave.op(name="My Custom Op Name")
     

TypeScript

Call のデフォルト名を上書きするには、weave.op() の呼び出し時に callDisplayName オプションを使用します。

const extractDinosOp = weave.op(extractDinos, {
callDisplayName: (input: string) => `Your New Display Name`
});

すでにログした Call の名を変更する必要がある場合は、実行後に Call の表示名を更新する こともできます。