Norman commited on
Commit
0be3b23
1 Parent(s): d9b097d

style(hus): add README english version (#4)

Browse files

* style(hus):add new chapter and new question

* style(hus):polish readme(add submit custom level)

* style(hus):fix chapter name

* style(hus): and README english version

Files changed (3) hide show
  1. README.md +32 -43
  2. README_zh.md +71 -0
  3. llmriddles/questions/__init__.py +1 -1
README.md CHANGED
@@ -1,13 +1,5 @@
1
  # LLM Riddles
2
 
3
- <!-- <div align="center">
4
- <br>
5
- <a href="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/banner.svg">
6
- <img src="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/banner.svg" width="1000" height="200" alt="Click to see the source">
7
- </a>
8
- <br>
9
- </div> -->
10
-
11
  <div align="center">
12
  <br>
13
  <a href="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/banner.svg">
@@ -16,60 +8,57 @@
16
  <br>
17
  </div>
18
 
19
- ## :thinking: 什么是LLM Riddles
20
- 欢迎来到 LLM Riddles!这是一个与语言模型斗智斗勇的游戏。在游戏中,你需要构造与语言模型交互的问题,来得到符合要求的答案。在这个过程中,你可以开动脑筋,用你想到的所有方式,让模型输出答案要求的结果。
21
 
22
- ## :space_invader: 如何试玩
23
- 我们提供了在线版本以供玩家直接访问试玩,本地部署可以通过以下方式:
24
- ### ChatGPT + 中文
25
  ```shell
26
  QUESTION_LANG=cn QUESTION_LLM='chatgpt' QUESTION_LLM_KEY=<your API key> python3 -u app.py
27
  ```
28
- ### ChatGPT + 英文
29
  ```shell
30
  QUESTION_LANG=en QUESTION_LLM='chatgpt' QUESTION_LLM_KEY=<your API key> python3 -u app.py
31
  ```
32
- ### Mistral-7B-Instruct-v0.1 + 英文
33
  ```shell
34
  QUESTION_LANG=en QUESTION_LLM='mistral-7b' python3 -u app.py
35
  ```
36
- ## :technologist: 为什么制作这个游戏
37
-
38
- 我们的目标是通过这一游戏,让参与者深入领略到提示工程(prompt engineering)和自然语言处理的令人着迷之处。这个过程将向玩家们展示,如何巧妙地构建提示词(prompts),以及如何运用它们来引发人工智能系统的惊人反应,同时也帮助他们更好地理解深度学习和自然语言处理技术的不可思议之处。
39
-
40
- ## :raising_hand: 如何提交设计好的关卡
41
- 如果有好玩的问题或想法,欢迎玩家提交自己的创意,可以
42
- [发起 Pull Request](https://github.com/opendilab/LLMRiddles/compare) 向我们提交, 我们会在审核通过后收录至关卡中。
43
- 问题的设计格式应包含以下几点:
44
- - Pull Request标题,示例:feature(username): 章节X-关卡设计
45
- - 希望被提及的ID
46
- - 对应章节问题文件的修改
47
- - init.py的修改
48
 
49
- 完整示例请参考:[提交属于自己的关卡设计]()
50
 
51
- ## :writing_hand: 未来计划
 
 
 
 
 
 
52
 
53
- - [x] 支持自定义关卡
54
- - [ ] 在线试玩链接
55
- - [ ] Hugging Face Space 链接
56
- - [x] 支持Mistral-7B-Instruct-v0.1(英文)
57
- - [ ] 支持Baichuan2-7B(中文)
58
- - [ ] 支持LLaMA2-7B(英文)
59
- - [ ] LLM 推理速度优化
60
 
 
61
 
62
- ## :speech_balloon: 反馈问题 & 提出建议
63
- - GitHub 上[发起 Issue](https://github.com/opendilab/CodeMorpheus/issues/new/choose)
64
- - 通过邮件与我们联系 ([email protected])
 
 
 
 
65
 
66
- - 在OpenDILab的群组中加入讨论(通过 WeChat: ding314assist 添加小助手微信)
 
 
 
67
  <img src=https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/wechat.jpeg width=35% />
68
 
69
  ## Special Thanks
70
- - 感谢 [Haoqiang Fan](https://www.zhihu.com/people/haoqiang-fan) 的原始创意和题目,为本项目的开发和扩展提供了灵感与动力。
71
- - 感谢 [HuggingFace](https://huggingface.co) 对游戏的支持与协助。
72
- - 感谢 [LLM Riddles contributors](https://github.com/opendilab/LLMRiddles/graphs/contributors) 的实现与支持。
73
 
74
  ## License
75
  All code within this repository is under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
 
1
  # LLM Riddles
2
 
 
 
 
 
 
 
 
 
3
  <div align="center">
4
  <br>
5
  <a href="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/banner.svg">
 
8
  <br>
9
  </div>
10
 
11
+ ## :thinking: What's This
12
+ Welcome to LLM Riddles! This is a game of wits and courage with language models. In the game, you need to construct questions that interact with the language model to get answers that meet the requirements. In this process, you can use your brain and use all the methods you can think of to get the model to output the results required by the answer.
13
 
14
+ ## :space_invader: How to Play
15
+ We provide an online version for players to directly access and try out. Local deployment can be done in the following ways:
16
+ ### ChatGPT + Chinese
17
  ```shell
18
  QUESTION_LANG=cn QUESTION_LLM='chatgpt' QUESTION_LLM_KEY=<your API key> python3 -u app.py
19
  ```
20
+ ### ChatGPT + English
21
  ```shell
22
  QUESTION_LANG=en QUESTION_LLM='chatgpt' QUESTION_LLM_KEY=<your API key> python3 -u app.py
23
  ```
24
+ ### Mistral-7B-Instruct-v0.1 + English
25
  ```shell
26
  QUESTION_LANG=en QUESTION_LLM='mistral-7b' python3 -u app.py
27
  ```
28
+ ## :technologist: Why Doing This
 
 
 
 
 
 
 
 
 
 
 
29
 
30
+ Our goal is to use this game to give participants a deeper understanding of the fascinating aspects of prompt engineering and natural language processing. This process will show players how to cleverly construct prompts and how to use them to trigger surprising responses from artificial intelligence systems, while also helping them better understand the incredible power of deep learning and natural language processing technologies. .
31
 
32
+ ## :raising_hand: How to Submit a Custom Level
33
+ If you have interesting questions or ideas, players are welcome to submit their own ideas. You can [Initiate a Pull Request](https://github.com/opendilab/LLMRiddles/compare) and submit it to us. We will include it in the level after approval.
34
+ The question format should include the following points:
35
+ - Pull Request title, example: feature(username): Chapter X-Level Design
36
+ - The ID you want to be mentioned
37
+ - Modify the corresponding chapter question files
38
+ - Modification of init.py
39
 
40
+ For a complete example, please refer to: [Submit your own level design]()
 
 
 
 
 
 
41
 
42
+ ## :writing_hand: Roadmap
43
 
44
+ - [x] Support custom levels
45
+ - [ ] Online trial link
46
+ - [ ] Hugging Face Space link
47
+ - [x] Support Mistral-7B(English version)
48
+ - [ ] Support Baichuan2-7B(Chinese version)
49
+ - [ ] Support LLaMA2-7B(English version)
50
+ - [ ] LLM inference speed optimization
51
 
52
+ ## :speech_balloon: Feedback and Contribution
53
+ - [Start an Issue](https://github.com/opendilab/CodeMorpheus/issues/new/choose) on GitHub
54
+ - Contact us by email ([email protected])
55
+ - Discuss on OpenDILab's WeChat group (i.e. add us on WeChat: ding314assist)
56
  <img src=https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/wechat.jpeg width=35% />
57
 
58
  ## Special Thanks
59
+ - Thanks to [Haoqiang Fan](https://www.zhihu.com/people/haoqiang-fan) for his original idea and title, which provided inspiration and motivation for the development and expansion of this project.
60
+ - Thanks to [HuggingFace](https://huggingface.co) for supporting and assisting the game.
61
+ - Thanks to [LLM Riddles contributors](https://github.com/opendilab/LLMRiddles/graphs/contributors) for their implementation and support.
62
 
63
  ## License
64
  All code within this repository is under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
README_zh.md ADDED
@@ -0,0 +1,71 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # LLM Riddles
2
+
3
+ <div align="center">
4
+ <br>
5
+ <a href="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/banner.svg">
6
+ <img src="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/banner.svg" width="1000" height="200" alt="Click to see the source">
7
+ </a>
8
+ <br>
9
+ </div>
10
+
11
+ ## :thinking: 什么是LLM Riddles
12
+ 欢迎来到 LLM Riddles!这是一个与语言模型斗智斗勇的游戏。在游戏中,你需要构造与语言模型交互的问题,来得到符合要求的答案。在这个过程中,你可以开动脑筋,用你想到的所有方式,让模型输出答案要求的结果。
13
+
14
+ ## :space_invader: 如何试玩
15
+ 我们提供了在线版本以供玩家直接访问试玩,本地部署可以通过以下方式:
16
+ ### ChatGPT + 中文
17
+ ```shell
18
+ QUESTION_LANG=cn QUESTION_LLM='chatgpt' QUESTION_LLM_KEY=<your API key> python3 -u app.py
19
+ ```
20
+ ### ChatGPT + 英文
21
+ ```shell
22
+ QUESTION_LANG=en QUESTION_LLM='chatgpt' QUESTION_LLM_KEY=<your API key> python3 -u app.py
23
+ ```
24
+ ### LLaMA2-7b + 中文
25
+ ```shell
26
+ QUESTION_LANG=cn QUESTION_LLM='llama2-7b' python3 -u app.py
27
+ ```
28
+ ### LLaMA2-7b + 英文
29
+ ```shell
30
+ QUESTION_LANG=en QUESTION_LLM='llama2-7b' python3 -u app.py
31
+ ```
32
+ ## :technologist: 为什么制作这个游戏
33
+
34
+ 我们的目标是通过这一游戏,让参与者深入领略到提示工程(prompt engineering)和自然语言处理的令人着迷之处。这个过程将向玩家们展示,如何巧妙地构建提示词(prompts),以及如何运用它们来引发人工智能系统的惊人反应,同时也帮助他们更好地理解深度学习和自然语言处理技术的不可思议之处。
35
+
36
+ ## :raising_hand: 如何提交设计好的关卡
37
+ 如果有好玩的问题或想法,欢迎玩家提交自己的创意,可以
38
+ [发起 Pull Request](https://github.com/opendilab/LLMRiddles/compare) 向我们提交, 我们会在审核通过后收录至关卡中。
39
+ 问题的设计格式应包含以下几点:
40
+ - Pull Request标题,示例:feature(username): 章节X-关卡设计
41
+ - 希望被提及的ID
42
+ - 对应章节问题文件的修改
43
+ - init.py的修改
44
+
45
+ 完整示例请参考:[提交属于自己的关卡设计]()
46
+
47
+ ## :writing_hand: 未来计划
48
+
49
+ - [x] 支持自定义关卡
50
+ - [ ] 在线试玩链接
51
+ - [ ] Hugging Face Space 链接
52
+ - [ ] 支持LLaMA2-7B(英文)
53
+ - [ ] 支持Mistral-7B(英文)
54
+ - [ ] 支持Baichuan2-7B(中文)
55
+ - [ ] LLM 推理速度优化
56
+
57
+ ## :speech_balloon: 反馈问题 & 提出建议
58
+ - 在 GitHub 上[发起 Issue](https://github.com/opendilab/CodeMorpheus/issues/new/choose)
59
+ - 通过邮件与我们联系 ([email protected])
60
+ - 在OpenDILab的群组中加入讨论(通过 WeChat: ding314assist 添加小助手微信)
61
+ <img src=https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/wechat.jpeg width=35% />
62
+
63
+ ## Special Thanks
64
+ - 感谢 [Haoqiang Fan](https://www.zhihu.com/people/haoqiang-fan) 的原始创意和题目,为本项目的开发和扩展提供了灵感与动力。
65
+ - 感谢 [HuggingFace](https://huggingface.co) 对游戏的支持与协助。
66
+ - 感谢 [LLM Riddles contributors](https://github.com/opendilab/LLMRiddles/graphs/contributors) 的实现与支持。
67
+
68
+ ## License
69
+ All code within this repository is under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
70
+
71
+ <p align="right">(<a href="#top">back to top</a>)</p>
llmriddles/questions/__init__.py CHANGED
@@ -10,4 +10,4 @@ _ = _level1_file_
10
  _ = _level2_file_
11
  _ = _level3_file_
12
  _ = _level4_file_
13
- _ = _level5_file_
 
10
  _ = _level2_file_
11
  _ = _level3_file_
12
  _ = _level4_file_
13
+ _ = _level5_file_