Hugging Face's logo

Spaces:
Tsumugii
/
PoetryChat
Runtime error

App Files Community
PoetryChat
File size: 3,259 Bytes 
ffaddbb
 
f7161fa
 
 
ffaddbb
f7161fa
ffaddbb
2f3124c
f7161fa
ffaddbb
f7161fa
ffaddbb
 
f7161fa
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
---
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

---



<div align="center"><h1>PoetryChat🖼️</h1></div>

</div>

[![License Apache 2.0](https://img.shields.io/badge/license-mit-blue.svg)](LICENSE)
[![python_version](https://img.shields.io/badge/Python-3.10%2B-green.svg)](requirements.txt)

<div align="center"><h2>Description</h2></div>

&emsp;&emsp;Powered by Large Language Models, PoetryChat ...



</div>

<div align="center"><h2>Demonstration</h2></div>

![诗趣伴行](./docs/诗趣伴行.png)

&emsp;&emsp;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](https://huggingface.co/spaces/Tsumugii/PoetryChat)

</div>

<div align="center"><h2>Todo</h2></div>

- [ ] 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





</div>

<div align="center"><h2>Quick Start</h2></div>

<details open>
    <summary><h4>Installation</h4></summary>


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

&emsp;&emsp;1. create a virtual `conda` environment for the demo 😆

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

&emsp;&emsp;2. Install essential `requirements` by run the following command in the `CLI` 😊

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

<details open>
    <summary><h4>Preparation</h4></summary>


&emsp;&emsp;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 = ""
```

&emsp;&emsp;2. xxx









</div>

<div align="center"><h2>References</h2></div>

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





</div>

<div align="center"><h2>Acknowledgements</h2></div>

&emsp;&emsp;***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](https://github.com/Tsumugii24)

- 朱嘉辉 [@jiaohui](https://github.com/jiaohuix)

- 陈思州 [@jjyaoao](https://github.com/jjyaoao)



</div>

<div align="center"><h2>Contact</h2></div>

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