sc_ma commited on
Commit
60047ee
1 Parent(s): d589ea7

Update Readme

Browse files
Files changed (2) hide show
  1. README.md +13 -13
  2. app.py +2 -3
README.md CHANGED
@@ -2,24 +2,24 @@
2
  sdk: gradio
3
  app_file: app.py
4
  license: mit
5
- title: 'Auto-Draft: 论文结构辅助工具'
6
  colorTo: indigo
7
  python_version: 3.10.10
8
  ---
9
 
10
 
11
- # Auto-Draft: 论文结构辅助工具
12
 
13
- 这个项目旨在为学术论文写作创建一个全自动辅助工具:搜索相关文献,拟定论文结构,生成论文模板。希望这个工具在未来可以让人们摆脱繁琐的论文写作,将工作的重心放在纯粹的科研上。
 
 
 
14
 
15
- ***Features***:
16
- * 提供论文标题,AI完成所有。
17
- * 真实的引用:所有引用的文献可以查找到真实的原文。
18
- * LaTeX模板直接编译。
19
 
20
- # Requirements
21
 
22
- 需要能使用GPT-4的API Key. 生成一篇论文需要15000 Tokens(大约0.5到0.8美元). 总共过程需要大约十分钟.
23
 
24
  # 使用方法
25
  1. 克隆此仓库:
@@ -30,14 +30,14 @@ git clone https://github.com/CCCBora/auto-draft
30
  ```angular2html
31
  pip install -r requirements.txt
32
  ```
33
- 3. 在`auto-draft`文件夹中,创建`api_key.txt`并在其中输入OpenAI API密钥。
34
- 4. 编辑`auto_draft.py`以自定义论文标题和描述,然后运行
35
  ```angular2html
36
- python auto_draft.py
37
  ```
38
 
39
  # 示例
40
- 直接运行 `auto_draft.py`的原始输出,直接编译得到 (全部输出存放在`outputs/outputs_20230420_114226`中):
41
 
42
  Page 1 | Page 2
43
  :-------------------------:|:-------------------------:
 
2
  sdk: gradio
3
  app_file: app.py
4
  license: mit
5
+ title: 'Auto-Draft: 文献整理辅助工具'
6
  colorTo: indigo
7
  python_version: 3.10.10
8
  ---
9
 
10
 
11
+ # Auto-Draft: 文献整理辅助工具
12
 
13
+ 这个项目旨在辅助AI领域学术论文的文献整理。提供如下功能:
14
+ * 主题归纳: 自动搜索相关文献,总结相关工作。
15
+ * 真实引用:所有引用的文献都有对应原文,避免AI胡说八道。
16
+ * 生成LaTeX模板: 输出直接可编译。
17
 
18
+ 运行过程需要能使用GPT-4的API Key. 生成一篇论文需要15000 Tokens(大约0.5到0.8美元). 总共过程需要大约十分钟.
 
 
 
19
 
20
+ # Demo地址
21
 
22
+ https://huggingface.co/spaces/auto-academic/auto-draft
23
 
24
  # 使用方法
25
  1. 克隆此仓库:
 
30
  ```angular2html
31
  pip install -r requirements.txt
32
  ```
33
+ 3. 在环境变量中设定OPENAI_API_KEY。
34
+ 4. 编辑`auto_backgrounds.py`以自定义想要探索的主题和描述,然后运行
35
  ```angular2html
36
+ python auto_backgrounds.py
37
  ```
38
 
39
  # 示例
40
+ `outputs` 文件夹中提供了部分输入的原始输出. 经由Overleaf直接编译得到.
41
 
42
  Page 1 | Page 2
43
  :-------------------------:|:-------------------------:
app.py CHANGED
@@ -2,8 +2,7 @@ import gradio as gr
2
  import openai
3
  from auto_backgrounds import generate_backgrounds
4
 
5
- # todo: 3. create a huggingface space. test it using multiple devices!
6
- # 5. Add more functions in this demo.
7
 
8
  def clear_inputs(text1, text2):
9
  return ("", "")
@@ -13,7 +12,7 @@ with gr.Blocks() as demo:
13
  # Auto-Draft: 论文结构辅助工具
14
 
15
  本Demo提供对[Auto-Draft](https://github.com/CCCBora/auto-draft)的auto_backgrounds功能的测试。通过输入一个领域的名称(比如Deep Reinforcement Learning),
16
- 即可自动生成对这个领域的Introduction,Related Works,和Backgrounds.
17
 
18
  ## 用法
19
 
 
2
  import openai
3
  from auto_backgrounds import generate_backgrounds
4
 
5
+ # todo:  5. Add more functions in this demo.
 
6
 
7
  def clear_inputs(text1, text2):
8
  return ("", "")
 
12
  # Auto-Draft: 论文结构辅助工具
13
 
14
  本Demo提供对[Auto-Draft](https://github.com/CCCBora/auto-draft)的auto_backgrounds功能的测试。通过输入一个领域的名称(比如Deep Reinforcement Learning),
15
+ 即可自动生成对这个领域的相关文献进行归纳总结.
16
 
17
  ## 用法
18