textgrad

环境要求

• Python 运行环境（README 未指定具体版本）
• pip 或 conda 包管理器（二选一）
• 可调用的 LLM 服务与对应 API 密钥（示例使用 gpt-4o）
• 可选：需要使用 vllm 时，环境中需具备 vllm 支持

安装与启动步骤

1. 1安装 TextGrad

   README 推荐的最简方式，直接用 pip 从 PyPI 安装 textgrad 包，适合大多数用户。

   pip install textgrad

   复制

2. 2conda 方式安装

   与上一步二选一。若使用 conda 管理环境，可从 conda-forge 渠道安装，包由官方 feedstook 维护。

   conda install -c conda-forge textgrad

   复制

3. 3安装最新开发版

   与上两步二选一。想用仓库中最新的 bleeding edge 代码时，直接从 GitHub 安装。

   pip install git+https://github.com/zou-group/textgrad.git

   复制

4. 4可选安装 vllm 支持

   只有在需要 vllm 相关能力时才执行，会安装 textgrad 的 vllm 附加依赖。

   pip install textgrad[vllm]

   复制

5. 5设置反向传播引擎

   导入 textgrad 并指定用于生成文本梯度的 LLM。新引擎基于 litellm，模型名需为 litellm 支持的名称。

   import textgrad as tg
   
   tg.set_backward_engine("gpt-4o", override=True)

   复制

6. 6定义损失与优化器

   用 TextLoss 写清评判要求，交给 TGD 优化器管理要优化的文本变量，再调用损失函数得到反馈。README 示例中的 solution 变量需由你自己先行定义。

   loss_fn = tg.TextLoss("You will evaluate a solution to a math question. Do not attempt to solve it yourself, do not give a solution, only identify errors. Be super concise.")
   
   optimizer = tg.TGD(parameters=[solution])
   loss = loss_fn(solution)

   复制

7. 7反向传播并更新

   对损失调用 backward() 生成文本梯度，再用 optimizer.step() 更新文本变量，最后打印优化后的文本。

   loss.backward()
   optimizer.step()
   print(solution.value)

   复制

关键配置

如何确认成功

跑通 QuickStart：loss_fn 输出错误分析，loss.backward() 与 optimizer.step() 后 print(solution.value) 打印出修正后的解答即成功。

常见问题

注意事项

• README 节选未给出 API 密钥的环境变量设置命令，请按你所使用模型服务商的文档自行配置密钥后再运行。
• README 提示基于 litellm 的新引擎目前仍是实验性的，未来计划的旧引擎会被弃用，选引擎时注意这一点。
• QuickStart 代码片段中的 solution 变量定义未在节选中给出，需自行构造待优化的文本变量后再运行后续步骤。