malvin noel commited on
Commit
ce31e17
Β·
1 Parent(s): df925fa

Update Readme 2

Browse files
Files changed (1) hide show
  1. README.md +11 -108
README.md CHANGED
@@ -1,112 +1,15 @@
1
- # πŸŽ₯ Light AI Video Generator
2
-
3
- **Light AI Video Generator** is an all-in-one Hugging Face Space that lets you create short, compelling AI-powered videos using **just a few inputs**. It handles everything β€” from script writing and voice generation to background video montage and subtitles.
4
-
5
- > βœ… No editing skills required.
6
- > πŸ”₯ Perfect for YouTube Shorts, TikTok, Reels, and more.
7
-
8
- ---
9
-
10
- ## πŸš€ Features
11
-
12
- ### 1. 🧠 AI Script Generation
13
- Use the built-in Qwen2.5 language model to automatically write a **concise, engaging script** based on your context and instructions.
14
- Prefer to write your own? Just switch to "Use my script" mode.
15
-
16
- ### 2. πŸ—£οΈ Voice Generation with Kokoro
17
- Your script is turned into a **natural-sounding AI voice** using Kokoro TTS (English voices). The voice is saved and synchronized with the final video.
18
-
19
- ### 3. 🎞️ Background Video Compilation
20
- Upload one or more `.mp4` clips to serve as the **background footage**. The app automatically stitches and syncs them to match your script duration.
21
-
22
- ### 4. 🎨 Video Style Settings
23
- Customize:
24
- - **Brightness**
25
- - **Contrast**
26
- - **Gamma**
27
-
28
- Perfect to match your aesthetic or highlight visuals better.
29
-
30
- ### 5. 🎡 Optional Background Music
31
- Optionally upload a `.mp3` music track to mix with the voiceover.
32
-
33
- ### 6. πŸ“ Subtitles (Optional)
34
- Enable dynamic subtitles that match the voiceover and are perfectly synced for better accessibility and viewer retention.
35
-
36
- ### 7. 🏷️ Title + Description + Tags
37
- Get a **YouTube-ready title, description, and hashtags** automatically generated to improve discoverability.
38
-
39
- ---
40
-
41
- ## πŸ§ͺ How to Use
42
-
43
- 1. Go to the **πŸ› οΈ Settings tab**:
44
- - Enter your **context** and **instruction**
45
- - Choose whether to auto-generate the script or input your own
46
- - Set your desired video **duration**, **style**, and upload your background video(s)
47
- - Optional: upload a music file and enable subtitles
48
-
49
- 2. Click **πŸš€ Generate the video**
50
-
51
- 3. Head to the **πŸ“€ Results tab** to:
52
- - Watch the generated video
53
- - Copy the script, title, and description with one click
54
-
55
  ---
56
-
57
- ## πŸ›  Technologies Used
58
-
59
- | Component | Technology |
60
- |------------------|----------------------------------|
61
- | UI | Gradio |
62
- | LLM | Qwen2.5 via Hugging Face |
63
- | Voice (TTS) | Kokoro 82M (open-weight TTS) |
64
- | Audio Processing | Pydub, Soundfile |
65
- | Video Editing | MoviePy |
66
- | Subtitles | Whisper (OpenAI) |
67
-
68
  ---
69
 
70
- ## πŸ“ Project Structure
71
-
72
- ```
73
- .
74
- β”œβ”€β”€ app.py # Gradio app logic & interface
75
- β”œβ”€β”€ requirements.txt # All needed dependencies
76
- β”œβ”€β”€ README.md # This file
77
- β”œβ”€β”€ scripts/
78
- β”‚ β”œβ”€β”€ generate_scripts.py # Script, title, description generation
79
- β”‚ β”œβ”€β”€ generate_voice.py # Kokoro voice synthesis
80
- β”‚ β”œβ”€β”€ get_footage.py # Background montage builder
81
- β”‚ β”œβ”€β”€ edit_video.py # Final audio/video editor
82
- β”‚ └── generate_subtitles.py # Whisper subtitle generation
83
- └── assets/ # Stores audio, video and outputs
84
- ```
85
-
86
- ---
87
 
88
- ## βœ… Requirements
89
-
90
- This app requires the following dependencies (automatically installed in Spaces):
91
-
92
- ```txt
93
- gradio
94
- torch
95
- transformers
96
- kokoro>=0.9.4
97
- soundfile
98
- pydub
99
- openai-whisper
100
- moviepy
101
- python-dotenv
102
- ```
103
-
104
- ---
105
-
106
- ## πŸ€– Credits
107
-
108
- Built by [Your Name or Team]
109
- Powered by Hugging Face πŸ€—, Qwen, and Kokoro TTS
110
- MIT License
111
-
112
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Light AI Video Generator
3
+ emoji: πŸš€
4
+ colorFrom: indigo
5
+ colorTo: emerald
6
+ sdk: gradio
7
+ sdk_version: 5.26.0
8
+ app_file: app.py
9
+ pinned: true
10
+ license: mit
11
+ short_description: Create short videos from text with AI voice, script, background, and subtitles.
 
 
12
  ---
13
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
 
15
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference