3v324v23 commited on
Commit
51c6129
2 Parent(s): bfdc2de 3c5122b

Merge branch 'master' of github.com:binary-husky/chatgpt_academic

Browse files
Files changed (1) hide show
  1. README.md +53 -22
README.md CHANGED
@@ -1,3 +1,5 @@
 
 
1
  # ChatGPT 学术优化
2
 
3
  **如果喜欢这个项目,请给它一个Star;如果你发明了更好用的学术快捷键,欢迎发issue或者pull requests**
@@ -16,6 +18,10 @@ https://github.com/polarwinkel/mdtex2html
16
  项目使用OpenAI的gpt-3.5-turbo模型,期待gpt-4早点放宽门槛😂
17
  ```
18
 
 
 
 
 
19
  <div align="center">
20
 
21
  功能 | 描述
@@ -39,7 +45,7 @@ chat分析报告生成 | [实验性功能] 运行后自动生成总结汇报
39
 
40
  - 新界面
41
  <div align="center">
42
- <img src="https://user-images.githubusercontent.com/96192199/227851398-fab5a158-aaf6-4151-95ac-a8172ce611c7.png" width="700" >
43
  </div>
44
 
45
 
@@ -71,34 +77,59 @@ chat分析报告生成 | [实验性功能] 运行后自动生成总结汇报
71
  <img src="https://user-images.githubusercontent.com/96192199/226935232-6b6a73ce-8900-4aee-93f9-733c7e6fef53.png" width="700" >
72
  </div>
73
 
74
- ## 直接运行 (Windows or Linux or MacOS)
75
 
76
- ``` sh
77
- # 下载项目
 
78
  git clone https://github.com/binary-husky/chatgpt_academic.git
79
  cd chatgpt_academic
80
- # 在config.py中,配置 海外Proxy 和 OpenAI API KEY
81
- - 1.如果你在国内,需要设置海外代理才能够使用 OpenAI API,你可以通过 config.py 文件来进行设置。
82
- - 2.配置 OpenAI API KEY。你需要在 OpenAI 官网上注册并获取 API KEY。一旦你拿到了 API KEY,在 config.py 文件里配置好即可。
83
- # 安装依赖
 
 
 
 
 
 
 
 
 
 
 
 
84
  python -m pip install -r requirements.txt
85
- # 运行
86
- python main.py
87
 
88
- # 测试实验性功能
89
- ## 测试C++项目头文件分析
90
- input区域 输入 ./crazy_functions/test_project/cpp/libJPG , 然后点击 "[实验] 解析整个C++项目(input输入项目根路径)"
91
- ## 测试给Latex项目写摘要
92
- input区域 输入 ./crazy_functions/test_project/latex/attention , 然后点击 "[实验] 读tex论文写摘要(input输入项目根路径)"
93
- ## 测试Python项目分析
94
- input区域 输入 ./crazy_functions/test_project/python/dqn , 然后点击 "[实验] 解析整个py项目(input输入项目根路径)"
95
- ## 测试自我代码解读
96
- 点击 "[实验] 请解析并解构此项目本身"
97
- ## 测试实验功能模板函数(要求gpt回答几个数的平方是什么),您可以根据此函数为模板,实现更复杂的功能
98
- 点击 "[实验] 实验功能函数模板"
99
  ```
100
 
 
 
 
 
 
101
 
 
 
 
 
 
 
 
 
 
 
 
 
 
102
  ## 使用docker (Linux)
103
 
104
  ``` sh
@@ -115,7 +146,7 @@ docker run --rm -it --net=host gpt-academic
115
  # 测试实验性功能
116
  ## 测试自我代码解读
117
  点击 "[实验] 请解析并解构此项目本身"
118
- ## 测试实验功能模板函数(要求gpt回答几个数的平方是什么),您可以根据此函数为模板,实现更复杂的功能
119
  点击 "[实验] 实验功能函数模板"
120
  ##(请注意在docker中运行时,需要额外注意程序的文件访问权限问题)
121
  ## 测试C++项目头文件分析
 
1
+
2
+
3
  # ChatGPT 学术优化
4
 
5
  **如果喜欢这个项目,请给它一个Star;如果你发明了更好用的学术快捷键,欢迎发issue或者pull requests**
 
18
  项目使用OpenAI的gpt-3.5-turbo模型,期待gpt-4早点放宽门槛😂
19
  ```
20
 
21
+ > **Note**
22
+ > 请注意只有“红颜色”标识的函数插件(按钮)才支持读取文件。目前暂不能完善地支持pdf格式文献的翻译解读,尚不支持word格式文件的读取。
23
+
24
+
25
  <div align="center">
26
 
27
  功能 | 描述
 
45
 
46
  - 新界面
47
  <div align="center">
48
+ <img src="https://user-images.githubusercontent.com/96192199/228600410-7d44e34f-63f1-4046-acb8-045cb05da8bb.png" width="700" >
49
  </div>
50
 
51
 
 
77
  <img src="https://user-images.githubusercontent.com/96192199/226935232-6b6a73ce-8900-4aee-93f9-733c7e6fef53.png" width="700" >
78
  </div>
79
 
80
+ ## 直接运行 (Windows, Linux or MacOS)
81
 
82
+ 下载项目
83
+
84
+ ```sh
85
  git clone https://github.com/binary-husky/chatgpt_academic.git
86
  cd chatgpt_academic
87
+ ```
88
+
89
+ 我们建议将`config.py`复制为`config_private.py`并将后者用作个性化配置文件以避免`config.py`中的变更影响你的使用或不小心将包含你的OpenAI API KEY的`config.py`提交至本项目。
90
+
91
+ ```sh
92
+ cp config.py config_private.py
93
+ ```
94
+
95
+ 在`config_private.py`中,配置 海外Proxy 和 OpenAI API KEY
96
+ ```
97
+ 1. 如果你在国内,需要设置海外代理才能够使用 OpenAI API,你可以通过 config.py 文件来进行设置。
98
+ 2. 配置 OpenAI API KEY。你需要在 OpenAI 官网上注册并获取 API KEY。一旦你拿到了 API KEY,在 config.py 文件里配置好即可。
99
+ ```
100
+ 安装依赖
101
+
102
+ ```sh
103
  python -m pip install -r requirements.txt
104
+ ```
 
105
 
106
+ 或者,如果你希望使用`conda`
107
+
108
+ ```sh
109
+ conda create -n gptac 'gradio>=3.23' requests
110
+ conda activate gptac
111
+ python3 -m pip install mdtex2html
 
 
 
 
 
112
  ```
113
 
114
+ 运行
115
+
116
+ ```sh
117
+ python main.py
118
+ ```
119
 
120
+ 测试实验性功能
121
+ ```
122
+ - 测试C++项目头文件分析
123
+ input区域 输入 `./crazy_functions/test_project/cpp/libJPG` , 然后点击 "[实验] 解析整个C++项目(input输入项目根路径)"
124
+ - 测试给Latex项目写摘要
125
+ input区域 输入 `./crazy_functions/test_project/latex/attention` , 然后点击 "[实验] 读tex论文写摘要(input输入项目根路径)"
126
+ - 测试Python项目分析
127
+ input区域 输入 `./crazy_functions/test_project/python/dqn` , 然后点击 "[实验] 解析整个py项目(input输入项目根路径)"
128
+ - 测试自我代码解读
129
+ 点击 "[实验] 请解析并解构此项目本身"
130
+ - 测试实验功能模板函数(要求gpt回答历史上的今天发生了什么),您可以根据此函数为模板,实现更复杂的功能
131
+ 点击 "[实验] 实验功能函数模板"
132
+ ```
133
  ## 使用docker (Linux)
134
 
135
  ``` sh
 
146
  # 测试实验性功能
147
  ## 测试自我代码解读
148
  点击 "[实验] 请解析并解构此项目本身"
149
+ ## 测试实验功能模板函数(要求gpt回答历史上的今天发生了什么),您可以根据此函数为模板,实现更复杂的功能
150
  点击 "[实验] 实验功能函数模板"
151
  ##(请注意在docker中运行时,需要额外注意程序的文件访问权限问题)
152
  ## 测试C++项目头文件分析