gpt-scrolls 项目介绍
项目概述
gpt-scrolls 是一个汇集了开源且安全的 GPT-3 提示词的项目,这些提示词经过优化,可以有效地达到预期效果。此项目倡导开放协作,欢迎任何人贡献他们的提示词。
如何开始
要使用 gpt-scrolls,首先需要获得 OpenAI API 的访问权限。如果还没有,可以去 OpenAI 的官网申请加入 Beta 版。
安装和配置 gpt-scrolls 非常简单,只需要几个步骤:
-
安装 gpt-scrolls 包:
$ pip install gpt-scrolls
-
设置环境变量以包含你的 OpenAI API 密钥:
$ export OPENAI_API_KEY=...
-
使用 python 运行并调用提示:
$ python -c "import scrolls; print(scrolls.run('creative/philosopher'))"
例如,调用
creative/philosopher
提示词可能生成关于仿真自动社会的描述。
在应用中运行 gpt-scrolls
开发者可以在自己的应用程序中集成和使用 gpt-scrolls。以下是一个使用 Python 代码片段的简单例子:
import scrolls
idea = scrolls.run('creative/business-ideas')
print(idea)
这段代码将会调用一个旨在生成“创意商业想法”的提示词,并输出一个想法,例如“最后一公里送货服务”。
本地运行 gpt-scrolls
如果不通过 pip
而想要直接从源码库运行 gpt-scrolls,可以按照以下步骤进行:
-
克隆项目仓库:
$ git clone git@github.com:maraoz/gpt-scrolls.git $ cd gpt-scrolls/
-
创建 Python 虚拟环境并安装依赖:
$ python3 -m venv .scrolls-env $ source .scrolls-env/bin/activate (.scrolls-env) $ pip install -r requirements.txt
-
运行项目提供的示例:
(.scrolls-env) $ python scrolls/run.py "top10/women"
这会生成一个关于历史上著名女性的列表。
设计目标
gpt-scrolls 的提示词设计有以下目标:
- 有效性:能够稳定地产生期望的输出类别。
- 效率:尽可能简短。
- 安全性:尽量减少有害输出的可能性。
贡献者在加入提示词或优化现有提示词时,需要考虑这些设计目标。例如,如果发现某个提示词可以在去除特定示例后仍保持有效性,可以提交优化请求以删除该示例,提高效率。
总结
gpt-scrolls 项目的目的是创建一个轻松安全的方式来调用 GPT-3 提示,使开发者和爱好者都可以轻松生成高质量文本。它支持协作,鼓励社区用户提出新想法和优化现有提示。随着项目的不断发展,开发者计划将其打造成一个易于使用的命令行工具。