README.md

# LLM Riddles

<div align="center">
	<br>
	<a href="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/banner.svg">
		<img src="https://github.com/opendilab/LLMRiddles/blob/main/llmriddles/assets/banner.svg" width="800" height="400" alt="Click to see the source">
	</a>
	<br>
</div>

## :thinking: What's This
欢迎来到 LLM Riddles！这是一个与语言模型斗智斗勇的游戏。在游戏中，你需要构造与语言模型交互的问题，来得到符合要求的答案。在这个过程中，你可以开动脑筋，用你想到的所有方式，让模型输出答案要求的结果。

## :space_invader: How to Play
我们提供了在线版本以供玩家直接访问试玩，本地部署可以通过以下方式：
### ChatGPT + 中文
```shell
QUESTION_LANG=cn QUESTION_LLM='chatgpt' QUESTION_LLM_KEY=<your API key> python3 -u app.py
```
### ChatGPT + 英文
```shell
QUESTION_LANG=en QUESTION_LLM='chatgpt' QUESTION_LLM_KEY=<your API key> python3 -u app.py
```
### LLaMA2-7b + 中文
```shell
QUESTION_LANG=cn QUESTION_LLM='llama2-7b' python3 -u app.py
```
### LLaMA2-7b + 英文
```shell
QUESTION_LANG=en QUESTION_LLM='llama2-7b' python3 -u app.py
```
## :technologist: 为什么制作这个游戏

我们的目标是通过这一游戏，让参与者深入领略到提示工程（prompt engineering）和自然语言处理的令人着迷之处。这个过程将向玩家们展示，如何巧妙地构建提示（prompts），以及如何运用它们来引发人工智能系统的惊人反应，同时也帮助他们更好地理解自然语言处理技术的不可思议之处。

## :raising_hand: 如何提交自己的创业
如果有好玩的问题或想法，欢迎玩家提交自己的创意，可以通过
[发起 Pull Request](https://github.com/opendilab/LLMRiddles/compare) 向我们提交， 我们会在审核通过后收录至关卡中。

## :speech_balloon: 反馈问题 & 提出建议
- [发起 Issue](https://github.com/opendilab/CodeMorpheus/issues/new/choose) 在 Github
- 通过邮件与我们联系 ([email protected])

- 在OpenDILab的群组中加入讨论(通过 WeChat: ding314assist 添加小助手微信)
<img src=https://github.com/opendilab/CodeMorpheus/blob/release/llmriddles/assets/wechat.jpeg width=35% />



## Special Thanks
- 感谢[HuggingFace](https://huggingface.co)对游戏的支持与协助
- 感谢[Haoqiang Fan](https://www.zhihu.com/people/haoqiang-fan)的创意与想法
- 感谢[LLM Riddles contributors](https://github.com/opendilab/LLMRiddles/graphs/contributors)的实现与支持