Weave by Weights & Biases

Weave 是一个用于开发生成式 AI 应用程序的工具包，由 Weights & Biases 构建。

---

您可以使用 Weave 来：

• 记录和调试 语言模型的输入、输出和跟踪信息
• 构建严谨、可比的评估 以应对语言模型的各种应用场景
• 整理整个 LLM 工作流中产生的所有信息，从实验、评估到生产部署

我们的目标是在开发生成式 AI 软件这一本质上充满实验性的过程中，引入严谨性、最佳实践和可组合性，同时避免增加认知负担。

文档

我们的文档网站可以在这里找到：weave 文档。

先决条件

• Python 3.10 或更高版本
• 一个 Weights & Biases 账户（提供免费层级）

快速入门

1. 安装 Weave：

   pip install weave
   

2. 导入并初始化：

   import weave
   weave.init("my-project-name")
   

3. 跟踪您的函数：

   @weave.op
   def my_function():
       # 您要跟踪的代码！
       pass
   

使用方法

跟踪

您可以使用 weave.op 跟踪任何函数——从调用 OpenAI、Anthropic、Google AI Studio 等 API 的操作，到调用 Hugging Face 和其他开源模型进行文本生成的操作，再到您代码中希望持续监控的任何验证函数或数据转换过程。

只需为所有需要跟踪的函数添加装饰器，即可生成一个包含所有函数输入和输出的跟踪树：

import weave
weave.init("weave-example")

@weave.op
def sum_nine(value_one: int):
    return value_one + 9

@weave.op
def multiply_two(value_two: int):
    return value_two * 2

@weave.op
def main():
    output = sum_nine(3)
    final_output = multiply_two(output)
    return final_output

main()

更完整的示例

import weave
import json
from openai import OpenAI

@weave.op
def extract_fruit(sentence: str) -> dict:
    client = OpenAI()

    response = client.chat.completions.create(
    model="gpt-3.5-turbo-1106",
    messages=[
        {
            "role": "system",
            "content": "您将收到非结构化数据，任务是将其解析为一个 JSON 字典，包含水果、颜色和风味三个键。"
        },
        {
            "role": "user",
            "content": sentence
        }
        ],
        temperature=0.7,
        response_format={ "type": "json_object" }
    )
    extracted = response.choices[0].message.content
    return json.loads(extracted)

weave.init('intro-example')

sentence = "在最近发现的 Goocrux 行星上发现了许多水果。那里生长着紫色的 neoskizzles，味道像糖果一样。"

extract_fruit(sentence)

贡献

想深入了解源码或参与贡献吗？太棒了！在开始之前，您需要了解以下内容。

我们目前正处于清理阶段 🧹 清理中 🧹 。这个代码库包含大量与“Weave 引擎”和“Weave 板”相关的代码，但我们已暂停这些部分的开发，转而专注于跟踪和评估功能。

Weave 的跟踪代码主要位于：weave/trace 和 weave/trace_server。

Weave 的评估代码主要位于：weave/flow。

Weave 快速上手指南

Weave 是由 Weights & Biases (W&B) 开发的生成式 AI 应用开发工具包，旨在帮助开发者记录、调试大语言模型（LLM）的输入输出与调用链路，并构建严谨的评估流程。

环境准备

在开始之前，请确保满足以下前置条件：

• Python 版本：Python 3.10 或更高版本
• W&B 账号：需要拥有一个 Weights & Biases 账号（提供免费层级），用于存储和可视化追踪数据。

安装步骤

使用 pip 安装 Weave：

pip install weave

提示：国内开发者若遇到下载速度慢的问题，可使用清华或阿里镜像源加速安装：

pip install weave -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

1. 初始化项目

导入 weave 并使用你的 W&B 项目名称进行初始化：

import weave
weave.init("my-project-name")

2. 追踪函数

使用 @weave.op 装饰器标记你希望追踪的函数。这将自动记录函数的输入、输出及执行链路，并在 W&B 面板中生成可视化的调用树。

以下是一个最简单的示例：

import weave
weave.init("weave-example")

@weave.op
def sum_nine(value_one: int):
    return value_one + 9

@weave.op
def multiply_two(value_two: int):
    return value_two * 2

@weave.op
def main():
    output = sum_nine(3)
    final_output = multiply_two(output)
    return final_output

main()

运行上述代码后，登录你的 W&B 控制台即可查看 weave-example 项目下的详细调用链路、参数及返回值。该机制同样适用于 OpenAI、Anthropic 等 API 调用或本地模型推理函数。