Spaces:
Runtime error
Runtime error
readme: update
Browse filesRe-format a part of the markdown content
and add conda instruction for installation.
Signed-off-by: Shengjiang Quan <[email protected]>
README.md
CHANGED
@@ -71,33 +71,66 @@ chat分析报告生成 | [实验性功能] 运行后自动生成总结汇报
|
|
71 |
<img src="https://user-images.githubusercontent.com/96192199/226935232-6b6a73ce-8900-4aee-93f9-733c7e6fef53.png" width="700" >
|
72 |
</div>
|
73 |
|
74 |
-
## 直接运行 (Windows
|
75 |
|
76 |
-
|
77 |
-
|
|
|
78 |
git clone https://github.com/binary-husky/chatgpt_academic.git
|
79 |
cd chatgpt_academic
|
80 |
-
|
81 |
-
|
82 |
-
|
83 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
84 |
python -m pip install -r requirements.txt
|
85 |
-
|
86 |
-
python main.py
|
87 |
|
88 |
-
|
89 |
-
|
90 |
-
|
91 |
-
|
92 |
-
|
93 |
-
|
94 |
-
input区域 输入 ./crazy_functions/test_project/python/dqn , 然后点击 "[实验] 解析整个py项目(input输入项目根路径)"
|
95 |
-
## 测试自我代码解读
|
96 |
-
点击 "[实验] 请解析并解构此项目本身"
|
97 |
-
## 测试实验功能模板函数(要求gpt回答几个数的平方是什么),您可以根据此函数为模板,实现更复杂的功能
|
98 |
-
点击 "[实验] 实验功能函数模板"
|
99 |
```
|
100 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
101 |
|
102 |
## 使用docker (Linux)
|
103 |
|
|
|
71 |
<img src="https://user-images.githubusercontent.com/96192199/226935232-6b6a73ce-8900-4aee-93f9-733c7e6fef53.png" width="700" >
|
72 |
</div>
|
73 |
|
74 |
+
## 直接运行 (Windows, Linux or MacOS)
|
75 |
|
76 |
+
下载项目
|
77 |
+
|
78 |
+
```sh
|
79 |
git clone https://github.com/binary-husky/chatgpt_academic.git
|
80 |
cd chatgpt_academic
|
81 |
+
```
|
82 |
+
|
83 |
+
我们建议将`config.py`复制为`config_private.py`并将后者用作个性化配置文件以避免`config.py`中的变更影响你的使用或不小心将包含你的OpenAI API KEY的`config.py`提交至本项目。
|
84 |
+
|
85 |
+
```sh
|
86 |
+
cp config.py config_private.py
|
87 |
+
```
|
88 |
+
|
89 |
+
在`config_private.py`中,配置 海外Proxy 和 OpenAI API KEY
|
90 |
+
|
91 |
+
1. 如果你在国内,需要设置海外代理才能够使用 OpenAI API,你可以通过 config.py 文件来进行设置。
|
92 |
+
2. 配置 OpenAI API KEY。你需要在 OpenAI 官网上注册并获取 API KEY。一旦你拿到了 API KEY,在 config.py 文件里配置好即可。
|
93 |
+
|
94 |
+
安装依赖
|
95 |
+
|
96 |
+
```sh
|
97 |
python -m pip install -r requirements.txt
|
98 |
+
```
|
|
|
99 |
|
100 |
+
或者,如果你希望使用`conda`
|
101 |
+
|
102 |
+
```sh
|
103 |
+
conda create -n gptac 'gradio>=3.23' requests
|
104 |
+
conda activate gptac
|
105 |
+
python3 -m pip install mdtex2html
|
|
|
|
|
|
|
|
|
|
|
106 |
```
|
107 |
|
108 |
+
运行
|
109 |
+
|
110 |
+
```sh
|
111 |
+
python main.py
|
112 |
+
```
|
113 |
+
|
114 |
+
测试实验性功能
|
115 |
+
|
116 |
+
- 测试C++项目头文件分析
|
117 |
+
|
118 |
+
input区域 输入 `./crazy_functions/test_project/cpp/libJPG` , 然后点击 "[实验] 解析整个C++项目(input输入项目根路径)"
|
119 |
+
|
120 |
+
- 测试给Latex项目写摘要
|
121 |
+
|
122 |
+
input区域 输入 `./crazy_functions/test_project/latex/attention` , 然后点击 "[实验] 读tex论文写摘要(input输入项目根路径)"
|
123 |
+
|
124 |
+
- 测试Python项目分析
|
125 |
+
|
126 |
+
input区域 输入 `./crazy_functions/test_project/python/dqn` , 然后点击 "[实验] 解析整个py项目(input输入项目根路径)"
|
127 |
+
|
128 |
+
- 测试自我代码解读
|
129 |
+
|
130 |
+
点击 "[实验] 请解析并解构此项目本身"
|
131 |
+
- 测试实验功能模板函数(要求gpt回答几个数的平方是什么),您可以根据此函数为模板,实现更复杂的功能
|
132 |
+
|
133 |
+
点击 "[实验] 实验功能函数模板"
|
134 |
|
135 |
## 使用docker (Linux)
|
136 |
|