From 940024e6dd92d9287a2cc520398cb4f0fe2e7c04 Mon Sep 17 00:00:00 2001 From: "wenmeng.zwm" Date: Wed, 8 Nov 2023 00:46:35 +0800 Subject: [PATCH] add readme and requirements.txt --- examples/apps/llm_riddles/README.md | 49 ++++++++++++++++++++++ examples/apps/llm_riddles/README_CN.md | 49 ++++++++++++++++++++++ examples/apps/llm_riddles/requirements.txt | 3 ++ 3 files changed, 101 insertions(+) create mode 100644 examples/apps/llm_riddles/README.md create mode 100644 examples/apps/llm_riddles/README_CN.md create mode 100644 examples/apps/llm_riddles/requirements.txt diff --git a/examples/apps/llm_riddles/README.md b/examples/apps/llm_riddles/README.md new file mode 100644 index 00000000..ff6e259e --- /dev/null +++ b/examples/apps/llm_riddles/README.md @@ -0,0 +1,49 @@ +# Oh No! I'm Surrounded by LLMs! (LLMRiddles) + +## Project Introduction +"Oh No! I'm Surrounded by LLMs!" is an intellectual challenge game that utilizes GPT-4. The game automatically generates corresponding game code based on existing Large Language Model (LLM) dialogue Gradio application codes within the ModelScope community, combined with preset questions from the Zhihu article ["How to Accomplish Tasks with 'Impossible'"](https://zhuanlan.zhihu.com/p/665393240), creating a unique gameplay experience. In this stream, players are required to cleverly construct questions that challenge the LLM to provide answers that meet specific conditions. + +## Getting Started + +### Online Experience + +[LLMRiddles](https://modelscope.cn/studios/LLMRiddles/LLMRiddles/summary) + +### Local Execution +To start the game, please follow the steps below: + +1. Clone the project code: + ``` + git clone https://github.com/modelscope/modelscope.git + ``` +2. Navigate to the `examples/apps/llm_riddles` directory. +3. Install the required Python dependencies with `pip install -r requirements.txt`. +4. Run the launch command `python app.py`. + +## Roadmap +- [x] Initial version source code and space experience ready. +- [ ] Support for custom questions and validation logic integration. +- [ ] Expand to 9 major levels, each with 9 questions. +- [ ] Support for more open-source models. +- [ ] Support for switching between cloud API and local inference. + +## Contribution Guide +We welcome everyone to contribute to "Oh No! I'm Surrounded by LLMs!", including proposing more fun questions, fixing validator corner cases, and providing more gameplay. Please follow the steps below: + +1. Visit the project address [ModelScope](https://github.com/modelscope/modelscope) and fork the project. +2. Create your feature branch in your local environment (`git checkout -b feature/AmazingFeature`). +3. Commit your changes (`git commit -m 'Add some AmazingFeature'`). +4. Push your changes to the branch (`git push origin feature/AmazingFeature`). +5. Initiate a Pull Request in the original project. + +## Community Contributors +We sincerely thank all community members who have contributed to this project, especially: + +- Idea from: [haoqiangfan](https://www.zhihu.com/people/haoqiang-fan) +- Most of the code is auto-generated by GPT-4 + +## Support +If you encounter any problems or need assistance during the game, please submit your issues on the project's [Issues page](https://github.com/modelscope/modelscope/issues). + +## Copyright and License +This project is licensed under the APACHE License. Please see the [LICENSE](https://github.com/modelscope/modelscope/blob/main/LICENSE) file in the project for more information. diff --git a/examples/apps/llm_riddles/README_CN.md b/examples/apps/llm_riddles/README_CN.md new file mode 100644 index 00000000..f67f5a87 --- /dev/null +++ b/examples/apps/llm_riddles/README_CN.md @@ -0,0 +1,49 @@ +# 完蛋！我被LLM包围了！(LLMRiddles) + +## 项目简介 +《完蛋！我被LLM包围了！》是一款智力挑战游戏。该游戏利用gpt4, 基于ModelScope社区内现有的LLM对话Gradio应用程序代码，结合知乎文章[《如何用“不可能”完成任务》](https://zhuanlan.zhihu.com/p/665393240)中的预设问题，自动生成了对应的游戏代码，创造了一个独特的游戏体验。在这个有溪中，玩家需要巧妙构造问题，挑战LLM给出满足特定条件的回答。 + +## 开始游戏 + +### 在线体验 + +[LLMRiddles](https://modelscope.cn/studios/LLMRiddles/LLMRiddles/summary) + +### 本地运行 +要开始游戏，请按照以下步骤操作： + +1. 克隆项目代码： + ``` + git clone https://github.com/modelscope/modelscope.git + ``` +2. 进入到`examples/apps/llm_riddles`目录。 +3. 安装所需的Python依赖`pip install -r requirements.txt`。 +4. 执行启动命令`python app.py`. + +## RoadMap +- [x] 初版本源码和创空间体验ready +- [ ] 支持自定义问题和验证逻辑接入 +- [ ] 扩充到9个大关卡，每个关卡9个问题 +- [ ] 支持更多开源模型 +- [ ] 支持云端API和本地推理切换 + +## 贡献指南 +我们欢迎大家为《完蛋！我被LLM包围了！》做出贡献，包括提出更多好玩的问题，修复validator的corner case，以及提供更多的玩法。请按以下步骤操作： + +1. 访问项目地址 [ModelScope](https://github.com/modelscope/modelscope) 并fork项目。 +2. 在你的本地环境中创建你的特性分支 (`git checkout -b feature/AmazingFeature`)。 +3. 提交你的改动 (`git commit -m 'Add some AmazingFeature'`)。 +4. 将你的改动推送到分支上 (`git push origin feature/AmazingFeature`)。 +5. 在原项目下发起一个Pull Request。 + +## 社区贡献者 +我们诚挚感谢所有对本项目做出贡献的社区成员，特别是： + +- idea来源: [haoqiangfan](https://www.zhihu.com/people/haoqiang-fan) +- 代码大部分来自于GPT4自动生成 + +## 支持 +如果你在游戏过程中遇到任何问题或需要帮助，请通过项目的[Issues页面](https://github.com/modelscope/modelscope/issues)提交你的问题。 + +## 版权和许可 +本项目采用APACHE License许可证。请查看项目中的[LICENSE](https://github.com/modelscope/modelscope/blob/main/LICENSE)文件了解更多信息。 diff --git a/examples/apps/llm_riddles/requirements.txt b/examples/apps/llm_riddles/requirements.txt new file mode 100644 index 00000000..371f609b --- /dev/null +++ b/examples/apps/llm_riddles/requirements.txt @@ -0,0 +1,3 @@ +dashscope +gradio +sympy