Skip to content

Latest commit

 

History

History
268 lines (167 loc) · 17.5 KB

README_EN.md

File metadata and controls

268 lines (167 loc) · 17.5 KB

SponsorShip | Report | Hiring | Personality

Chat-Haruhi-Suzumiya

Reviving Anime Character in Reality via Large Language Model

Code License Data License Huggingface Gradio

Temporary experience link: https://e295a4ebe3b687f461.gradio.live

Temporary experience link2: https://3a86a62a612c531114.gradio.live

English | Chinese简体中文 | 🤗 Hugging Face | 📜 Paper | 🤗🗃️ 54k Dataset |

Chat-Haruhi-Suzumiyais a language model that imitates the tone, personality and storylines of characters like Haruhi Suzumiya,

The project was developed by Cheng Li, Ziang Leng, Chenxi Yan, Xiaoyang Feng, HaoSheng Wang, Junyi Shen, Hao Wang, Weishi Mi, Aria Fei, Song Yan, Linkang Zhan, Yaokai Jia, Pingyu Wu, and Haozhen Sun,etc.

This is an open source project and the members were recruited from open source communities like DataWhale.

Lulu Li( Cheng Li@SenseTime )initiated the whole project and designed and implemented most of the features.

Ziang Leng( Ziang Leng@SenseTime )designed and implemented the training, data generation and backend architecture for ChatHaruhi 1.0.

Chenxi Yan( Chenxi Yan@Chengdu University of Information Technology )implemented and maintained the backend for ChatHaruhi 1.0.

Junyi Shen( Junyi Shen@Zhejiang University )implemented the training code and participated in generating the training dataset.

Hao Wang( Hao Wang )collected script data for a TV series and participated in data augmentation.

Weishi Mi( Weishi MI@Tsinghua University )participated in data augmentation.

Aria Fei( Aria Fei@BJUT )implemented the ASR feature for the script tool and participated in the Openness-Aware Personality paper project.

Xiaoyang Feng( Xiaoyang Feng@Nanjing Agricultural University )integrated the script recognition tool and participated in the Openness-Aware Personality paper project.

Yue Leng ( Song Yan )Collected data from The Big Bang Theory. Implemented script format conversion.

scixing(HaoSheng Wang)( HaoSheng Wang ) implemented voiceprint recognition in the script tool and tts-vits speech synthesis.

Linkang Zhan( JunityZhan@Case Western Reserve University ) collected Genshin Impact's system prompts and story data.

Yaokai Jia( Yaokai Jia )implemented the Vue frontend and practiced GPU extraction of Bert in a psychology project.

Pingyu Wu( Pingyu Wu@Juncai Shuyun )helped deploy the first version of the training code.

Haozhen Sun( [Haozhen Sun@Tianjin University] )plot the character figures for ChatHaruhi.

Chat-Haruhi-Suzumiya is one of the subproject of Luotuo, which was initiated by Cheng Li, Ziang Leng, and Qiyuan Chen.

This project is a work in progress. With the release of the Arxiv version, we will publish a dataset supporting 32 characters and 52K dialogues, along with the corresponding local model and ChatHaruhi1.0 inference code, within a week. We will then begin refactoring the project for ChatHaruhi2.0.

This project is licensed under Apache 2.0, which permits commercial use. However, you still need to comply with other relevant agreements, including:

  • The copyright of the character roles themselves.

  • The terms of any APIs used in the project, such as OpenAI's agreement.

  • The licenses of any models used in the project (for example, if we later adopt models from LlaMA or GLM, etc).

Quick Start

To get started with the ChatHaruhi1.0 project, you can directly run the following Colab notebooks:

Name Colab Link Description
ChatHaruhi1.0 Open In Colab 能够支持角色切换的功能整合客户端
ChatHaruhi2.0(EA) Open In Colab ChatHaruhi2.0的openAI版本已经能运行了

We are refactoring the code for ChatHaruhi 2.0, which will be solve the high module coupling problem of version 1.0 - it will be released as a pip-installable library with improved modularity. But you can still start the gradio demo through the first colab link. If you need a pure python backend, ChatHaruhi 2.0 code can already be installed via pip.

News

[2023-08-22] Dataset Released on Hugging Face

[2023-08-21] ChatHaruhi tech report on arXiv.

[2023-06-07] Chat Haruhi Suzumiya won the second prize in the Create@AI Hackathon hosted by the Modelscope Community, co-sponsored by Alibaba Cloud and NVIDIA, and co-organized by Tianchi(top3), video

[2023-06-03] Honored with second prize(top3) and do oral presentation in July 17 for CAAI 8th-Big Data and Social Computing: 8th China National Conference, BDSC 2023, Urumqi, China, July 15–17, 2023 ,for more details link

Demo Video

The VITS model used in the video was generously provided by the Haruhi Suzumiya Support Group. We are still refining the perforamnce. Please note this video contains audio 📢 .

My.Movie540.mp4

Content

ChatHaruhi_2.0_Design

ChatHaruhi started as an open source project with multimodal features like images and voice added to participate in competitions. Developers can now try the Gradio demo in the source code. However, this design isn't ideal for future research goals like adding characters, studying interactions, enhancing memory, or connecting to a Unity game backend.

After this arxiv release, we will rebuild ChatHaruhi with the following planned interfaces:

from ChatHaruhi import ChatHaruhi

chatbot = ChatHaruhi( system_prompt = 'prompt.txt', \
                      story_db = 'story_chroma_folder', \
                      llm = 'openai' )
                      
response = chatbot.chat(text = 'Can you introduce youself?', role = 'Kyon' )

The system will use a simple system_prompt parameter and vector database for access. It will support switching between LLMs like the locally trained model from this paper, Claude, Spark API, etc. For conversations using the ChatHaruhi-52K characters, you can use them directly out of the box below.

from chatharuhi import ChatHaruhi

chatbot = ChatHaruhi( role_name = 'baizhantang', llm = 'openai')

response = chatbot.chat(role='汪捕快',text ='小二,来斤好久,再来两盘羊肉!')

chatharuhi has already one version upload to pypi, you can install the preliminary version from pip install chatharuhi. For more things: https://github.com/LC1332/Haruhi-2-Dev

Quick Start of Each Demo

Name Colab Link Description
ChatHaruhi 1.0 Open In Colab A functionally integrated client capable of supporting role switching
Genesis Open In Colab the first gradio chat developed by Lulu Li
Baidu Studio Version Baidu Studio Version A simplified version of Baidu Studio developed by DataWhale teaching assistant - Qijun Ma
HuggingFace Version Huggingface Gradio HuggingFace Version
personality - College entrance exam essay Open In Colab College entrance exam essay generator tailored to high or low openness personalities,link
personality-Chatbot Open In Colab Chatbot corresponding to high/low open personality,link
Chat Megumi Open In Colab Chat Megumi was created using a corpus collected by community friends.

Tutorial Video in Chinese

Video Description
Roadmap in 5 minutes AI Hackathon of Modelscope in Bilibi
DataWhale Presentation Instructional video created for a DataWhale assignment
Script Tool Tutorial Step-by-step guide to using the yuki_builder scripting tool
Character Data Format Tutorial Tutorial on the character data format and converting text files to configuration files.
ModelScope Tutorial in 40 minutes 40-tutorial in entry-level, with an additional 40 minutes for discussion and Q&A

TODO and Feature

TODO:

  • train the model of the original corpus of 22k stories
  • release technical report on arxiv
  • release local inference code
  • release trained model with 52k data
  • Support local model and OpenAI's ChatHaruhi2.0, update to github
  • quick install with pip

Honors

  • 🏆 Chat Haruhi Suzumiya won the second prize in the Create@AI Hackathon hosted by the Modelscope Community, co-sponsored by Alibaba Cloud and NVIDIA, and co-organized by Tianchi(top3) video

  • 🏆 Honored with the second prize (top3) and do oral presentation in July 17 for CAAI 8th-Big Data and Social Computing: 8th China National Conference, BDSC 2023, Urumqi, China, July 15–17, 2023 for more details

SponsorShip

Due to Chat Haruhi Suzumiya adopts a strategy similar to CoT, which is 10-20 times more expensive than usual. Currently, API tokens are supported by community donations.

In addition, we are actively looking for GPUs (A100, A800). If you are willing to donate, please contact us. We greatly appreciate any support to help keep Chat Haruhi Suzumiya running.

If you are interested in sponsoring the Luotuo Project, please click on the major project or view the sponsorship form.

Back to top

Members

Citation

Please cite the repo if you use the data or code in this repo.

@misc{li2023chatharuhi,
      title={ChatHaruhi: Reviving Anime Character in Reality via Large Language Model}, 
      author={Cheng Li and Ziang Leng and Chenxi Yan and Junyi Shen and Hao Wang and Weishi MI and Yaying Fei and Xiaoyang Feng and Song Yan and HaoSheng Wang and Linkang Zhan and Yaokai Jia and Pingyu Wu and Haozhen Sun},
      year={2023},
      eprint={2308.09597},
      archivePrefix={arXiv},
      primaryClass={cs.CL}
}

Star History Chart

If you have any suggestions for the project, such as the interface design of ChatHaruhi2.0, or want to add references to the future version of this report, please submit the issue.