WordsStory / README.md
redstoneleo's picture
Update README.md
88ac395 verified

A newer version of the Gradio SDK is available: 6.13.0

Upgrade
metadata
title: WordsStory
emoji: 🐨
colorFrom: indigo
colorTo: indigo
sdk: gradio
sdk_version: 5.49.1
app_file: app.py
pinned: false

🌟 项目简介

单词故事 :听故事 = 复习 + 记忆单词!
单词故事利用 AI 将用户提供的一组单词或短语编成一个有趣的小故事,然后合成音频,使用户可以通过听故事来复习之前记过的单词——将枯燥的单词记忆变得轻松有趣起来!

该项目融合了以下技术:

  • 🧩 LLM 模型 - 文心大模型4.5 (旗舰版API) — 用于生成英文故事。

  • 🔊 TTS 引擎 - Azure TTS — 将生成的故事转换为音频。

  • 💬 Gradio Web 界面 — 让用户可直接在浏览器中交互、试听与下载故事。


💡 使用示例

请看视频 https://www.bilibili.com/video/BV1hVsAzBEDm/


🚀 功能特色

✍️ 英文故事生成

自动使用输入单词或短语生成轻松有趣的英文小故事和对应的中文翻译,每个故事最多由7个单词或短语构成,这是这是由George A. Miller (1956) 的论文The Magical Number Seven, Plus or Minus Two所揭示的记忆规律。

🧠 语义上下文学习

通过听觉与语境加深记忆,提高单词理解

🔊 语音合成

生成 .mp3 音频故事包括各单词或短语的发音、释义、中英文故事,可下载到手机或电脑反复使用

🖥️ Gradio 图形界面

无需命令行操作,浏览器直接使用


💡 在线使用

虽然Gitcode Space的文档里提到了环境变量配置,但实际上并未找到相应的设置入口,为了避免泄露自己的API Key,所以本项目不能在Gitcode Space上直接体验,要体验请自己在本地部署(方法见后文)或访问


⚙️ 部署指南

1️⃣ 克隆项目

# Make sure git-lfs is installed (https://git-lfs.com)
git lfs install

git clone https://huggingface.co/spaces/redstoneleo/WordsStory

# If you want to clone without large files - just their pointers

GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/spaces/redstoneleo/WordsStory

cd WordsStory

2️⃣ 创建虚拟环境

这里使用 uv

uv venv SiteEnv
source SiteEnv/bin/activate  # Windows: .\SiteEnv\Scripts\activate

3️⃣ 安装依赖

uv pip install -r requirements.txt

若使用 pip

pip install -r requirements.txt

4️⃣ 设置环境变量

这里以Windows上的PowerShell设置为例

setx AZURE_TTS_KEY "your_AZURE_TTS_KEY"
setx OPENAI_API_KEY "your_BAIDU_CHATAI_KEY"

其中Azure TTS的API Key可以按照文档说明去获取,需要绑定信用卡。文心大模型4.5 旗舰版API Key可以到这里获取。

5️⃣ 启动 Gradio Web 界面

python app.py

然后打开浏览器访问:

👉 http://127.0.0.1:7860