From f2826dc61317c43a025f75ba35398e0fcd07a0bb Mon Sep 17 00:00:00 2001 From: sean1832 Date: Sat, 4 Mar 2023 04:15:24 +1100 Subject: [PATCH] doc: update README.md --- Documentation/README_CN.md | 19 +++++++++++-------- Documentation/README_JP.md | 23 +++++++++++++++-------- README.md | 28 ++++++++++++++++++++-------- 3 files changed, 46 insertions(+), 24 deletions(-) diff --git a/Documentation/README_CN.md b/Documentation/README_CN.md index 9df7554..76c7852 100644 --- a/Documentation/README_CN.md +++ b/Documentation/README_CN.md @@ -9,8 +9,15 @@ *💡本人并非专业程序猿，并且是一个python小白，此项目可能会出现各种bug。如果你遇到bug，请在[问题栏](https://github.com/sean1832/GPT-Brain/issues)里提出，我会尽可能的进行修补。* +### 简介 +本程序利用[GPT-3](https://platform.openai.com/docs/models/gpt-3)和[3.5](https://platform.openai.com/docs/models/gpt-3-5)的能力，提供对原子笔记内容的概括，以及针对笔记的特定内容的回答。 +该程序扫描指定目录（通常是包含多个笔记的vault），并将所有笔记的内容附加到单个文件中。 +该文件随后用作用户查询的上下文。程序能够识别笔记内容之间的关系，并生成一个精炼的回答，概括关键要点。 + +尽管该程序与使用markdown或txt的其他笔记软件兼容，但它主要是针对[Obsidian](https://obsidian.md/)设计的。 + ### 功能 -- [x] 使用 [OpenAI GPT-3](https://platform.openai.com/docs/models/gpt-3) 生成回答。 +- [x] 使用 [OpenAI GPT-3](https://platform.openai.com/docs/models/gpt-3)和 [GPT-3.5 (ChatGPT)](https://platform.openai.com/docs/models/gpt-3-5) 生成回答。 - [x] 使用 [OpenAI embedding](https://platform.openai.com/docs/guides/embeddings/what-are-embeddings) 对笔记内容和问题进行对称比较，以增强搜索效果。 - [x] 可配置prompt。 - [x] 可个性化的个人背景信息以获得更贴切的答案。 @@ -23,13 +30,9 @@ - [x] 基本和高级参数滑块，以便于调整OpenAI语言模型配置。 ### 未来计划 -- [x] ~~batch脚本更新库。~~ -- [x] ~~版本控制。~~ -- [x] ~~参数提示。~~ -- [x] ~~支持多语言UI~~。 -- [x] ~~支持多语言检索。~~ -- [ ] 提供详细操作指南。 -- [ ] 发布windows版本。 +- [ ] 支持PDF笔记格式。 +- [ ] 支持PDF OCR扫描。 +- [ ] 支持Word文档格式。 ## 安装 ### 1. 所需条件 diff --git a/Documentation/README_JP.md b/Documentation/README_JP.md index d4fbdfd..0412b66 100644 --- a/Documentation/README_JP.md +++ b/Documentation/README_JP.md @@ -9,8 +9,19 @@ *💡私はプロのプログラマーではなく、Pythonにもかなり慣れていないため、このプロジェクトにはバグが含まれているかもしれません。もし何か問題があれば、[Issues section](https://github.com/sean1832/GPT-Brain/issues)で提案してください。* +### 紹介 +このプログラムは、[GPT-3](https://platform.openai.com/docs/models/gpt-3)と[3.5](https://platform.openai.com/docs/models/gpt-3-5)の力を活用して、原子的なノートの内容の要約と、 +特定のノートに関連する質問に回答することを提供します。 +プログラムは、通常、複数のノートを含むvaultとして指定されたディレクトリをスキャンし、 +すべてのノートの内容を単一のファイルに追加します。 +このファイルは、ユーザーのクエリの文脈として機能します。プログラムは、ノートの内容の関係を識別し、 +主要なポイントを要約する洗練された応答を生成できます。 + +このプログラムは、markdownまたはtxtを使用する他のノート取りソフトウェアでも互換性がありますが、 +主に[Obsidian](https://obsidian.md/)を想定して設計されています。 + ### フィーチャー -- [x] [OpenAI GPT-3](https://platform.openai.com/docs/models/gpt-3)を使って、レスポンスを生成します。 +- [x] [OpenAI GPT-3](https://platform.openai.com/docs/models/gpt-3)と[GPT-3.5 (ChatGPT)](https://platform.openai.com/docs/models/gpt-3-5)を使って、レスポンスを生成します。 - [x] [OpenAIエンベッディング](https://platform.openai.com/docs/guides/embeddings/what-are-embeddings)を使用して、質問とノートの内容を意味的に比較し、検索を強化します。 - [x] 設定可能なプロンプト。 - [x] より正確な回答を得るために、個人の背景情報をカスタマイズすることができます。 @@ -23,13 +34,9 @@ - [x] OpenAI言語モデルの構成に対する基本的および高度なパラメータースライダー。。 ### Todo -- [x] ~~ライブラリの更新を行うバッチスクリプト。~~ -- [x]　~~バージョニング。~~ -- [x] ~~パラメータに関するヒント。~~ -- [x] ~~多言語UI。~~ -- [x] ~~多言語検索に対応。~~ -- [ ] ユーザー向けの詳細なドキュメントを提供する。 -- [ ] Windows用をリリース。 +- [ ] PDFサポート。 +- [ ] PDF OCRスキャンをサポート。 +- [ ] Word文書をサポート。 ## 設置 ### 1. 必要なもの diff --git a/README.md b/README.md index c20c67f..bb2a2e2 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,23 @@ *💡As I am not a professional programmer and am fairly new to Python, this project may contain bugs. If you encounter any issues, please suggest them in the [Issues section](https://github.com/sean1832/GPT-Brain/issues).* +### Description +This program leverages the power of [GPT-3](https://platform.openai.com/docs/models/gpt-3) & [3.5](https://platform.openai.com/docs/models/gpt-3-5) to provide a summary of the content of atomic notes, +as well as answer questions related specifically to your notes. +The program scans a designated directory, +which is typically a vault containing multiple notes, +and appends the contents of all the notes to a single file. +This file then serves as the context for the user's query. +The program is able to identify +relationships between the contents of the notes, +and generate a refined response that summarizes the key points. + +Although the program is compatible with other note-taking software that uses +markdown or txt, +it is primarily designed with [Obsidian](https://obsidian.md/) in mind. + ### Feature -- [x] Use [OpenAI GPT-3](https://platform.openai.com/docs/models/gpt-3) to generate response. +- [x] Use [OpenAI GPT-3](https://platform.openai.com/docs/models/gpt-3) and [GPT-3.5 (ChatGPT)](https://platform.openai.com/docs/models/gpt-3-5) to generate response. - [x] Use [OpenAI embedding](https://platform.openai.com/docs/guides/embeddings/what-are-embeddings) for semetic comparison of question and note content for enhanced searching. - [x] Configurable prompts. - [x] Customizable personal background information for more accurate answers. @@ -23,13 +38,10 @@ - [x] Basic & Advanced parameter sliders for OpenAI Language model configurations. ### Todo -- [x] ~~Batch script to update library.~~ -- [x] ~~Versioning.~~ -- [x] ~~Tooltips for parameters.~~ -- [x] ~~Multilingual support for UI.~~ -- [x] ~~Multilingual search support.~~ -- [ ] Provide detail documentation for users. -- [ ] Release for windows. +- [ ] Support PDF format。 +- [ ] Support PDF OCR scan。 +- [ ] Support Word document。 + ## Install ### 1. What you need