Skip to content

Latest commit

 

History

History
194 lines (135 loc) · 6.34 KB

README_zh.md

File metadata and controls

194 lines (135 loc) · 6.34 KB

English | 简体中文

Contributors Forks Stargazers Issues MIT License


Logo

Polish-Your-Prompt

让所有人成为提示词大师!

查看示例 · 网页界面 · 报告错误 · 新功能

Workflow

目录
  1. 关于项目
  2. 快速开始
  3. 使用
  4. 路线
  5. 许可
  6. 致谢

关于项目

Workflow

提示词工程中,究竟哪里是工程?

提示工程是工程与艺术的结合。有些人很擅长写提示词,他们能用很自然的方式和大语言模型交流。但是,很多人可能做不到。 他们可能需要额外的帮助来创建高质量的提示词,以用于生成令人满意的文本。

在这个项目中,我们构建了一个工具,能够让你轻松成为提示词大师,创造出可以在你的余生中重复使用的提示词。

我们提供了3种类型的提示词优化器:

  1. Simple Refiner: 通过简单的前缀优化你的提示词。
  2. Schema Refiner: 通过广泛使用的提示词模板来优化你的提示词,例如COSTAR, RISE.
  3. Annotated Refiner: 通过文本批注来优化你的提示词

查看 示例 来获取更多细节。

查看 schemas 获取更多模板。

快速开始

安装

pip install polish_your_prompt

配置

.env 文件中,输入你的大模型 API base 和 API key (如果没有这个文件,就创建一个).

API_BASE="your-api-base"
API_KEY="your-api-key"

理论上,只要大模型支持 OpenAI API 风格,就可以使用这个工具。

使用

SchemaRefiner 为例:

from polish_your_prompt.core import SchemaRefiner, MODE
from polish_your_prompt.schemas import  *
prompt = "help me do my homework"
refiner = SchemaRefiner()
structure, prompt = refiner.refine(prompt, schema=COSTAR(), mode=MODE.ONE_STEP)

COSTAR 是由新加坡政府技术局(GovTech)组织的新加坡首届“GPT-4提示词工程”比赛中, Sheila Teo 提出的一个提示词模板。

查看 文章 获取更多细节。

LLM会将输入的提示词转换成一个 COSTAR 风格的结构,如:

# CONTEXT #
You are a student in high school taking a math class.

# OBJECTIVE #
Seek assistance with completing your homework assignment.

# STYLE #
Informal student seeking help.

# TONE #
Polite and respectful.

# AUDIENCE #
Classmate or tutor who can provide guidance.

# RESPONSE #
Clear explanation of the homework task and request for assistance.\n'

在大多数情况下,LLM 会生成一个更令人满意的回答。

查看 示例 获取更多细节。

路线

  • 一个网页界面
  • 多语言支持
    • 中文
  • 一个给非程序员的网页界面
  • 提供给LLM死亡威胁或10美元小费的选择

想要贡献?查看 open issues

如果你有一个可以让这个项目变得更好的建议,请 fork 这个仓库并创建一个 pull request。 你也可以简单地开启一个带有“enhancement”标签的ISSUE

别忘了给个star!谢谢!

许可

MIT License. 查看LICENSE.txt

致谢

对本项目有启发的项目或文章: