Create README.md

README.md

@@ -0,0 +1,26 @@
+MusicLang text-chord-predictor
+===============================
+
+MusicLang text-chord-predictor is the easiest to use model from the musiclang family. 
+It can be used without any third party library. Just input a chord progression in standard pop format (eg : START CM Dm G7/B ), the model will simply predict the next chords.
+You can use it to create a song harmonic structure quickly.
+
+Some Caveats
+=============
+
+- Please include the "START" token at the beginning of your prompt to maximize model performances
+- Some chords are not in the vocabulary, but they always have an enharmonic equivalent (There is no C#M but a DbM). If the tokenizer can't parse your chord consider changing it by the enharmonic equivalent
+- We only support M (major), m (minor), 7 (seventh dominant chords), M7 (Major with major seventh), m7 (minor with minor sevenths), m7b5 (half diminished chords), dim (diminished triad), dim7 (diminished seventh chord), aug (augmented chord)
+- We don't support other chord extensions, if you are interested by an extended model please contact me
+- We support all inversions of the chord using the / notation (eg : CM/E is a C major chord over bass of E). We currently don't support bass note that does not belong to the chord (DM/C will lead to an error, use D7/C)
+- It does not focus on harmonic ryhthm, only chord progression
+- Use [musiclang package](https://github.com/musiclang/musiclang) to parse your chord progressions and create cool voicings from them, or create new musical ideas !
+
+License
+========
+
+This model is free to use for research and open source purpose only. Please credit me (Florian GARDIN) and musiclang if you do so. 
+If you would like to use this in a commercial product please contact [us](florian.gardin@musiclang.io) to discuss licensing terms and potential integration in your product. I am looking forward to hearing about your project !
+
+
+