DocsGPT 介绍
了解项目的详细信息和使用方法
DocsGPT 🦖
DocsGPT 是一个开源的文档助手，它集成了强大的 GPT 模型，帮助开发者快速找到项目文档中的信息。它能够回答与项目相关的问题，让开发者告别耗时的手动搜索，轻松找到所需信息。试用一下 DocsGPT，看看它如何改变你的项目文档体验。还可以参与开发，成为 AI 助手的未来的一部分。
我们提供了针对公司的生产支持和帮助，为您部署 DocsGPT 至实际环境时提供个性化的协助。
项目路线图：您可以在这里找到我们的路线图。请随时贡献或创建问题，它可以帮助我们改进 DocsGPT！
我们提供了优化用于 DocsGPT 的开源模型，如下所示：
- Docsgpt-7b-falcon：Falcon-7b，要求 1 个 A10G 显卡
- Docsgpt-14b：llama-2-14b，要求 2 个 A10 显卡
- Docsgpt-40b-falcon：falcon-40b，要求 8 个 A10G 显卡
如果您没有足够的资源来运行这些模型，可以使用 bitsnbytes 进行量化。
DocsGPT 的主要特性包括：
- 快速搜索：在项目文档中快速搜索信息
- 语法提示：提供合理的语法提示
- 代码示例：为您提供代码示例以解决问题
- 关键字筛选：根据关键字筛选相关信息
- 用户反馈：获取用户反馈以改进系统
- 自定制功能：根据需求自定义功能
有用的链接：
项目结构：
- 应用 - Flask 应用（主要应用程序）
- 扩展 - Chrome 扩展程序
- 脚本 - 创建其他库的相似性搜索索引的脚本
- 前端 - 使用 Vite 和 React
快速入门：
请确保已安装 Docker。
在 Mac OS 或 Linux 上运行以下命令：
./setup.sh
它将安装所有依赖项，并允许您下载本地模型或使用 OpenAI。
开发环境：
- 启动 Mongo 和 Redis
- 运行后端
- 启动前端
贡献：请参考 CONTRIBUTING.md 文件以获取有关如何参与贡献的信息。我们欢迎问题、疑问和拉取请求。
行为准则：我们承诺为我们的社区创建一个无骚扰的环境，使每个人都能享受参与的乐趣。请参考 CODE_OF_CONDUCT.md 文件以获取更多关于贡献的信息。
特别感谢我们的贡献者！
许可证：源代码采用 MIT 许可证。详见 LICENSE 文件。
本项目利用了 :bird: :link: LangChain 构建。