Clemylia/Miamuy-midi

Documentation du modèle Miamuy-midi 🎵

Bienvenue sur la page de documentation de Miamuy-midi, un modèle JavaScript qui génère des mélodies. Ce modèle a été conçu pour l'apprentissage et la création musicale.

---

✨ Qu'est-ce que c'est ?

Miamuy-midi est un modèle génératif basé sur des règles. Son but est de créer des séquences de notes MIDI à partir d'une note de départ fournie par l'utilisateur. C'est un outil parfait pour composer de petites mélodies ou pour explorer la musique algorithmique.

Ce modèle fonctionne entièrement côté client, ce qui le rend ultra-léger et rapide, car il ne dépend d'aucun serveur externe.

---

🧠 Comment ça fonctionne ?

Le modèle Miamuy-midi suit un processus simple mais efficace :

1. Saisie de la note : Le modèle reçoit en entrée une note de départ (par exemple, "C4").
2. Création de la séquence : Il génère une séquence de notes en alternant de manière semi-aléatoire des notes autour de la note de départ pour créer une mélodie cohérente.
3. Sortie des données : Le modèle renvoie une liste des notes générées, à la fois sous forme de noms de notes lisibles par l'humain et sous forme de valeurs MIDI numériques.

---

💻 Comment utiliser le modèle

Tu peux utiliser ce modèle dans n'importe quel projet JavaScript en l'important directement depuis le Hugging Face Hub.

Installation

Il n'y a pas d'installation ! Tu as juste besoin d'accéder au fichier du modèle via son URL.

Exemple d'utilisation

Voici comment appeler et utiliser le modèle :

import MiamuyMidiModel from 'https://huggingface.co/Clemylia/Miamuy-midi/raw/main/transformer.js';

// Crée une instance du modèle
const miamuy = await MiamuyMidiModel.getInstance();

// Génère une séquence de notes à partir de la note de départ 'C4'
const result = await miamuy.generate('C4', { length: 8 });

// Affiche les notes générées
console.log(result[0].generated_text); // Ex: "C4 F4 G4 C5 A4 D5 G4 B4"
console.log(result[0].midi_notes);    // Ex: [60, 65, 67, 72, 69, 74, 67, 71]

---

⚙️ Paramètres de la méthode generate

La méthode generate accepte une chaîne de caractères pour la note de départ (prompt) et un objet options optionnel :

• prompt (string) : La note de départ pour la mélodie (ex: 'C4', 'A#3'). Obligatoire.
• options.length (number, optionnel) : La longueur de la séquence à générer. Par défaut, la longueur est de 8 notes.

---

✍️ Auteur

Ce modèle a été créé par Clemylia.

---

📄 Licence

Ce modèle est sous licence Apache-2.0.

---