vancenceho commited on
Commit
f827db7
·
verified ·
1 Parent(s): d194b23

docs: update README

Browse files
Files changed (1) hide show
  1. README.md +61 -3
README.md CHANGED
@@ -1,3 +1,61 @@
1
- ---
2
- license: cdla-sharing-1.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cdla-sharing-1.0
3
+ language:
4
+ - en
5
+ tags:
6
+ - music
7
+ - code
8
+ pretty_name: Spotify Million Song Lyrics Cleaned
9
+ size_categories:
10
+ - 10K<n<100K
11
+ ---
12
+
13
+ # Spotify Million Song Lyrics Cleaned
14
+
15
+ CSV of **deduplicated, normalized lyrics** aligned to the Million Song–style raw lyrics dump used in the *viral-content-predictor* project. Each row is one **(artist, song)** identity after normalization; lyrics are cleaned text suitable for TF‑IDF, retrieval, or joining to Spotify metadata via `artist_norm` / `title_norm`.
16
+
17
+ ## File
18
+
19
+ | File | Role |
20
+ |------|------|
21
+ | `lyrics_cleaned.csv` | One row per normalized `(artist_norm, title_norm)`; includes raw display columns and lyric text. |
22
+
23
+ ## Source
24
+
25
+ - **Upstream:** Raw lyrics table (e.g. `spotify_millsongdata.csv` in `data/raw/`), derived from the **Spotify Million Song Dataset**–style corpus.
26
+ - **Pipeline:** `notebooks/exploratory/explore_lyrics_clean.ipynb` — normalization, lyric text cleanup, **deduplication** (keeping the longest lyric per normalized artist–title pair where applicable).
27
+
28
+ ## Schema (typical columns)
29
+
30
+ | Column | Description |
31
+ |--------|-------------|
32
+ | `artist` | Original artist string. |
33
+ | `song` | Original track title string. |
34
+ | `artist_norm` | Normalized artist key for joins. |
35
+ | `title_norm` | Normalized title key for joins. |
36
+ | `lyrics_char_len` | Character length of the lyric text (or similar size signal). |
37
+ | `lyrics` | Full lyric text (cleaned). |
38
+
39
+ Exact column order and any extra fields follow the exporting notebook revision.
40
+
41
+ ## Usage
42
+
43
+ ```python
44
+ import pandas as pd
45
+
46
+ lyr = pd.read_csv("lyrics_cleaned.csv")
47
+ # Join to Spotify-side tables on artist_norm / title_norm (and track_id after mapping)
48
+ ```
49
+
50
+ ## Size note
51
+
52
+ The **full** cleaned file can be **large** (multi‑million characters / many rows). If your snapshot is bigger than `10K<n<100K`, update the Hub **`size_categories`** in the YAML (e.g. `1M<n<10M` or `n>10M`) so the dataset card matches reality.
53
+
54
+ ## Limitations
55
+
56
+ - **Language:** Primarily **English** lyrics in practice; not language-tagged per row in this export.
57
+ - **Rights:** Lyrics are third-party content; redistribution must respect **CDLA-Sharing-1.0** (this card), the original dataset license, and applicable copyright rules in your jurisdiction.
58
+
59
+ ## Citation
60
+
61
+ Cite the original **Million Song Dataset** / lyrics source you used, plus your repository or notebook revision for the cleaning steps.