Skip to content

Commit 121a0b3

Browse files
update readme
1 parent bc08239 commit 121a0b3

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed

Melody-Generation/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,16 +141,17 @@ This function:
141141

142142
- **Root Mean Square Error (RMSE)**: Measures the average magnitude of error between the predicted and actual values, particularly useful for numeric features like `duration` and `step`. Lower RMSE values indicate more accurate predictions. It is calculated as:
143143

144-
$$
144+
```math
145145
RMSE = \sqrt{\frac{1}{N} \sum_{i=1}^{N} (y_i - \hat{y}_i)^2}
146-
$$
146+
```
147147

148148

149149
- **Coefficient of Determination (R²)**: Evaluates the proportion of variance in the actual values explained by the model, R² values close to 1 indicate the model captures the underlying patterns well. It is calculated as:
150150

151-
$$
151+
152+
```math
152153
R^2 = 1 - \frac{\sum_{i=1}^N (y_i - \hat{y}_i)^2}{\sum_{i=1}^N (y_i - \bar{y})^2}
153-
$$
154+
```
154155

155156

156157
### Evaluation Process

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,41 @@
22

33
## Overview
44

5-
[In process...]
6-
5+
**Melody-Lyric-Generator** is designed to combine melody generation and lyric generation for creating cohesive musical content. It processes, analyzes, and generates melodies using MIDI data, while simultaneously handling lyric extraction and fine-tuning for generating Spanish-language text. This project employs advanced datasets, custom preprocessing functions, and machine learning models to produce high-quality musical and lyrical outputs.
76

87
**Content:**
98

109
- [Lyrics Generation](#lyrics-generation)
1110
- [Melody Generation](#melody-generation)
12-
- [Usage](#usage)
1311

1412
---
1513

1614
## Lyrics Generation
1715

18-
[In process...]
16+
**Lyrics Generation** processes and analyzes song lyrics using the LyricsGenius API, cleaning the data and identifying emotional content through a lexicon-based approach. Additionally, it fine-tunes the pre-trained [`datificate/gpt2-small-spanish`](https://huggingface.co/datificate/gpt2-small-spanish) model for text generation.
17+
18+
**Key Features:**
19+
- **Data Cleaning**: Removes unnecessary elements such as metadata, punctuation, and stopwords.
20+
- **Emotional Analysis**: Identifies emotions in lyrics using a specialized lexicon.
21+
- **Fine-Tuning GPT**: Trains the model across multiple datasets, optimizing for coherent and emotionally rich text.
22+
23+
---
1924

2025
## Melody Generation
2126

22-
[In process...]
27+
**Melody Generation** processes, analyzes, and generates melodies using the MAESTRO dataset and custom MIDI handling functions. A machine learning model is trained to predict musical notes, evaluate performance, and produce cohesive melodies.
28+
29+
**Key Features:**
30+
- **Custom MIDI Functions**: Includes tools for note extraction, sequence creation, and MIDI playback.
31+
- **Neural Network Architecture**: Trains on features like pitch, step, and duration to predict melodies.
32+
- **Evaluation Metrics**: Uses RMSE and R² to measure the quality of generated melodies.
2333

2434

25-
## Usage
35+
---
2636

37+
<div align="center">
38+
<em>
39+
We believe in the power of collaboration. If you have ideas, suggestions, or improvements, feel free to open an issue or submit a pull request. Let’s make this project even better—your contributions are always welcome!
40+
</em>
41+
</div>
2742

0 commit comments

Comments
 (0)