gpt3 poc tutorial with braindump

头脑转储

更新（2023 年 11 月）：首选新的 GPT-3.5-Turbo 版本。我添加了支持聊天完成 API 的新版本（使用 GPT-3.5-Turbo 进行测试）。适当的子文件夹（ gpt-3 、 gpt-35-turbo ）现在包含原始版本和新版本。除了模型更改和相应调整之外，它们是相同的，但首选gpt-35-turbo ，因为 GPT-3 补全已弃用。

Braindump 是一个原型应用程序，用于记录笔记并将其转换为更容易查询的数据库。只需输入您的想法，应用程序就会对其进行正确分类、切片和存储以供以后使用。它是作为演示构建的，旨在展示如何利用 GPT-3 从概念验证开始构建应用程序，如我的 Data Science @ Microsoft 教程“构建 GPT-3 应用程序 - 超越提示”中所述。您可以使用它来遵循教程，也可以将其作为您自己的研究和应用的起点（例如，通过在您自己的不同问题中重用实用函数和总体程序结构）。

它是一个简单的 Python 应用程序，利用 Streamlit 提供 Web 界面。要实际调用 GPT-3 模型，您需要有一个可用的 OpenAI API 密钥。在撰写本文时，创建帐户后，您将获得一些免费积分，这些积分足以遵循教程并开始使用该应用程序。该应用程序还应该与 Azure OpenAI 服务一起使用，而不是原始的 OpenAI 产品，尽管我尚未在那里进行测试。

除了应用程序本身之外，该存储库还包括导致该应用程序的 Jupyter 笔记本形式的研究。

搜索的 UI 如下所示：

要添加事实，UI 如下，包括可选的模型解释手动检查：

运行应用程序或研究

该应用程序已在 Python 3.8 (GPT-3) 和 3.10 (GPT-3.5-Turbo) 上进行了测试。您需要的主要库是： openai 、 streamlit 、 pandas 、 notebook 、 pytest 。您可以手动安装它们，也可以按照以下过程创建新环境并自动安装它们。请注意，对于较旧的代码库，您将需要旧版本的openai库。

运行应用程序：

1. 建议您运行 Anaconda 发行版中的 Python 3.10+，可以在此处获取。
2. 为了确保正确安装依赖项，您可以首先使用conda create -n braindump_py310 python=3.10专门为此应用程序创建一个新环境
3. 使用conda activate braindump_py310激活新环境
4. 对于 GPT-3.5-Turbo（推荐），安装requirements.txt中列出的依赖项。您可以通过从项目根目录运行pip install -r requirements.txt来完成此操作。对于原始 GPT-3 版本（已弃用），请改用requirements.gpt3.txt ，以获取其操作所需的旧依赖项。
5. 获取您需要的可用 OpenAI API 密钥，并将其作为名为OPENAI_API_KEY的环境变量提供。
6. 最后，从项目的根目录启动应用程序。在 Windows 上： run.gpt3.bat （GPT-3 版本）或run.gpt35turbo.bat （GPT-3.5-Turbo 版本）；在 Linux 上： run.gpt3.sh （GPT-3 版本）或run.gpt35turbo.sh （GPT-3.5-Turbo 版本）。

进行研究：

1. 除最后一步外，请按照上述步骤操作。
2. 使用您最喜欢的 Jupyter 客户端在notebooks/下打开所需的 Jupyter 笔记本（就我个人而言，我经常使用 VS Code）。

项目结构

该项目的结构如下：

• notebooks/ ：用于即时工程的 Jupyter 笔记本。
• src/ ：最终应用程序的源代码。
  • src/gpt-3 ：原始 GPT-3 版本的来源（已弃用）。
  • src/gpt-3.5-turbo ：GPT-3.5-Turbo 版本的来源（自 2023 年 11 月起推荐）。
• data/ ：应用程序存储的数据。
• tests/ ：应用程序的单元测试。
  • tests/gpt-3/ ：测试原始 GPT-3 版本（已弃用）。
  • tests/gpt-3.5-turbo/ ：GPT-3.5-Turbo 版本的测试（自 2023 年 11 月起推荐）。
• docs/ ：文档和相关资产。

方法

该方法在我的 Data Science @ Microsoft 教程“构建 GPT-3 应用程序 - 超越提示”中详细介绍。尽管如此，让我在这里强调一些关键点：

• 大型语言模型，特别是 GPT-3、GPT-3.5-Turbo 和 GPT-4，提供了一种相对简单且非常灵活的方式来构建某些类型的软件。然而，要真正构建一个健壮且可用的应用程序，还需要大量额外的软件工程方面的知识。
• 概念验证 (PoC) 非常适合探索新技术的功能并以低成本快速展示价值。因此，如果有必要的话，它们提供了一种获得更多投资的方法。由于 GPT-3 等法学硕士的应用仍然是一个非常新的领域，因此 PoC 是探索该空间和学习的好方法。
• 渐进、迭代的过程是构建此类 PoC 和应用程序的最佳方式。从一个简单的用例开始，然后逐渐添加功能和复杂性。
• 通过这种方式，现在可以用相对较少的努力取得令人印象深刻的成果。以前成本太高甚至不可能做的事情现在变得可行。因此，对于个人和组织来说，这都是提高生产力的好方法。是时候探索和尝试以前不可想象的项目了！

就具体阶段而言，建议采取以下措施

• 尝试使用 OpenAI Playground 一些非常简单的案例，看看这个想法是否值得更多的工作。
• 一旦您决定继续，请编写一个简单的规范，其中包含您将操作的基本数据结构以及一些输入和输出的示例。
• 将问题分解为子问题，并确定哪些子问题可以通过 GPT-3 或类似模型来处理。
• 逐步、迭代地设计您的提示，最好使用 Jupyter 笔记本。
• 一旦对提示的质量感到满意，请将它们和辅助机制封装在引擎中。
• 为您的引擎构建 UI，最好使用 Streamlit 或 Gradio 之类的工具，这两种工具都可以非常快速地产生良好的结果。
• 向利益相关者展示 PoC 并酌情进行迭代。

执照

麻省理工学院许可证

版权所有 (c) 2023 保罗·萨勒姆·达席尔瓦

特此免费授予获得本软件和相关文档文件（“软件”）副本的任何人不受限制地使用本软件，包括但不限于使用、复制、修改、合并的权利、发布、分发、再许可和/或销售软件的副本，并允许向其提供软件的人员这样做，但须满足以下条件：

上述版权声明和本许可声明应包含在本软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、特定用途的适用性和不侵权的保证。在任何情况下，作者或版权持有者均不对因本软件或本软件的使用或其他交易而引起的或与之相关的任何索赔、损害或其他责任负责，无论是合同、侵权还是其他行为。软件。