README.md

metadata

title: PoetryChat
emoji: 🤗
colorFrom: indigo
colorTo: indigo
sdk: gradio
sdk_version: 3.43.2
app_file: app.py
hf_oauth: true
pinned: true
license: mit

PoetryChat🖼️

Description

  Powered by Large Language Models, PoetryChat ...

Demonstration

  You can easily and directly experience the our demo online on HuggingFace now. Click here for Online Experience 👉 PoetryChat - a Hugging Face Space by Tsumugii

Todo

• Complete the Gradio Interface and UI design
• Add team members brief introduction
• Add a gif demonstration
• Deploy the demo on HuggingFace
• RAG layer
• LLM Agent layer
• Application layer

Quick Start

Installation

  First of all, please make sure that you have already installed conda as Python runtime environment. And miniconda is strongly recommended.

  1. create a virtual conda environment for the demo 😆

$ conda create -n poetrychat python==3.10 # poetrychat is the name of your environment
$ conda activate poetrychat

  2. Install essential requirements by run the following command in the CLI 😊

$ git clone https://github.com/Antony-Zhang/PoetryChat && cd PoetryChat && git checkout poetryChat2.0
$ pip install -r requirements.txt

Preparation

  1. open .env.example and fill your own API Keys in the corresponding place if you want to use certain LLM, then rename the file into .env

OPENAI_API_KEY = ""
OPENAI_URL_BASE = ""

  2. xxx

References

1. Gradio Official Documents
2. LIC·2024 语言与智能技术竞赛_飞桨大赛-飞桨AI Studio星河社区
3. PoetryChat: 一个面向不同年龄段的交互式LLM古诗学习助手
4. Tsumugii24/WonderWhy (github.com)

Acknowledgements

  I would like to express my sincere gratitude to my teammates for their efforts and supports throughout the development of this project. Their expertise and insightful feedback played a crucial role in shaping the direction of the project.

• 姜舒凡 @Tsumugii24

• 朱嘉辉 @jiaohui

• 陈思州 @jjyaoao

Contact

Feel free to open GitHub issues or directly send me a mail if you have any questions about this project.