TuTuHuss commited on
Commit
2023f77
1 Parent(s): 4ccff9f

style(hus):add readme

Browse files
Files changed (2) hide show
  1. README.md +43 -7
  2. llmriddles/assets/wechat.jpeg +0 -0
README.md CHANGED
@@ -1,16 +1,52 @@
1
- # LLMRiddles
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="800" height="400" alt="Click to see the source">
7
  </a>
8
  <br>
9
  </div>
10
 
11
- ```shell
12
- # QUESTION_LANG=en
13
- # QUESTION_LLM=chatgpt
14
 
15
- python app.py
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # LLM Riddles
2
 
3
  <div align="center">
4
  <br>
5
+ <a href="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/asserts/banner.svg">
6
+ <img src="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/asserts/banner.svg" width="800" height="400" alt="Click to see the source">
7
  </a>
8
  <br>
9
  </div>
10
 
11
+ ## :thinking: What's This
12
+ 欢迎来到 LLM Riddles!这是一个与语言模型斗智斗勇的游戏。在游戏中,你需要构造与语言模型交互的问题,来得到符合要求的答案。在这个过程中,你可以开动脑筋,用你想到的所有方式,让模型输出答案要求的结果。
 
13
 
14
+ ## :space_invader: How to Play
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
+ ## :speech_balloon: 反馈问题 & 提出建议
41
+ - [发起 Issue](https://github.com/opendilab/CodeMorpheus/issues/new/choose) 在 Github
42
+ - 通过邮件与我们联系 (opendilab@pjlab.org.cn)
43
+
44
+ - 在OpenDILab的群组中加入讨论(通过 WeChat: ding314assist 添加小助手微信)
45
+ <img src=https://github.com/opendilab/CodeMorpheus/blob/release/llmriddles/assets/wechat.jpeg width=35% />
46
+
47
+
48
+
49
+ ## Special Thanks
50
+ - 感谢[HuggingFace](https://huggingface.co)对游戏的支持与协助
51
+ - 感谢[Haoqiang Fan](https://www.zhihu.com/people/haoqiang-fan)的创意与想法
52
+ - 感谢[LLM Riddles contributors](https://github.com/opendilab/LLMRiddles/graphs/contributors)的实现与支持
llmriddles/assets/wechat.jpeg ADDED