James Edmunds commited on
Commit Β·
d74e599
1
Parent(s): f87cd97
Add data directory structure with .gitkeep files and usage instructions
Browse files- README.md +23 -3
- data/processed/embeddings/.gitkeep +3 -0
- data/raw/lyrics/.gitkeep +10 -0
README.md
CHANGED
|
@@ -146,9 +146,29 @@ SongLift_LyrGen2/
|
|
| 146 |
β βββ utils/ # Utility functions
|
| 147 |
βββ scripts/ # Data processing & testing
|
| 148 |
βββ data/
|
| 149 |
-
β βββ raw/lyrics/ #
|
| 150 |
-
β βββ processed/ #
|
| 151 |
-
βββ
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 152 |
```
|
| 153 |
|
| 154 |
## π Browser Compatibility
|
|
|
|
| 146 |
β βββ utils/ # Utility functions
|
| 147 |
βββ scripts/ # Data processing & testing
|
| 148 |
βββ data/
|
| 149 |
+
β βββ raw/lyrics/ # Place your lyrics files here (organized by artist folders)
|
| 150 |
+
β βββ processed/ # Generated embeddings & ChromaDB files
|
| 151 |
+
βββ .env.example # Environment variables template
|
| 152 |
+
```
|
| 153 |
+
|
| 154 |
+
### π Data Directory Setup
|
| 155 |
+
|
| 156 |
+
The `data/` directory structure is preserved for you to add your own lyrics:
|
| 157 |
+
|
| 158 |
+
```
|
| 159 |
+
data/raw/lyrics/
|
| 160 |
+
βββ artist1/
|
| 161 |
+
β βββ song1.txt
|
| 162 |
+
β βββ song2.txt
|
| 163 |
+
βββ artist2/
|
| 164 |
+
β βββ song1.txt
|
| 165 |
+
β βββ song2.txt
|
| 166 |
+
βββ ...
|
| 167 |
+
```
|
| 168 |
+
|
| 169 |
+
After adding lyrics, run the processing pipeline:
|
| 170 |
+
```bash
|
| 171 |
+
python scripts/process_lyrics.py
|
| 172 |
```
|
| 173 |
|
| 174 |
## π Browser Compatibility
|
data/processed/embeddings/.gitkeep
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# This file ensures the embeddings directory structure is preserved in git
|
| 2 |
+
# Processed embeddings and ChromaDB files will be stored here
|
| 3 |
+
# This directory is populated by running: python scripts/process_lyrics.py
|
data/raw/lyrics/.gitkeep
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# This file ensures the lyrics directory structure is preserved in git
|
| 2 |
+
# Place your lyrics files (.txt) in this directory organized by artist folders
|
| 3 |
+
# Example structure:
|
| 4 |
+
# data/raw/lyrics/
|
| 5 |
+
# βββ artist1/
|
| 6 |
+
# β βββ song1.txt
|
| 7 |
+
# β βββ song2.txt
|
| 8 |
+
# βββ artist2/
|
| 9 |
+
# βββ song1.txt
|
| 10 |
+
# βββ song2.txt
|