Update README.md

README.md

@@ -10,4 +10,65 @@ tags:
 
 songstarter-v0.1 is a MusicGen 32k model fine-tuned on a dataset of hip-hop/rap/trap/rnb/soul melody loops. It's intended to be used to generate song ideas that are useful for music producers.
 
-This is a proof of concept. Hopefully, we will be able to collect more data and train a better models in the future.
+This is a proof of concept. Hopefully, we will be able to collect more data and train a better models in the future.
+
+## Usage
+
+Install [audiocraft](https://github.com/facebookresearch/audiocraft):
+
+```
+pip install -U git+https://github.com/facebookresearch/audiocraft#egg=audiocraft
+```
+
+Then, you should be able to load this model just like any other musicgen checkpoint here on the Hub:
+
+```python
+from audiocraft.models import musicgen
+
+model = musicgen.MusicGen.get_pretrained('nateraw/songstarter-v0.1', device='cuda')
+```
+
+To generate and save audio samples, you'd then do:
+
+```python
+from datetime import datetime
+from pathlib import Path
+
+from audiocraft.models import musicgen
+from audiocraft.data.audio import audio_write
+from audiocraft.utils.notebook import display_audio
+
+model = musicgen.MusicGen.get_pretrained('nateraw/songstarter-v0.1', device='cuda')
+
+# path to save our samples.
+out_dir = Path("./samples")
+out_dir.mkdir(exist_ok=True, parents=True)
+
+model.set_generation_params(
+    duration=15,
+    use_sampling=True,
+    temperature=1.0,
+    top_k=250,
+    cfg_coef=3.0,
+)
+
+text = "hip hop, soul, piano, chords, jazz, neo jazz, G# minor, 140 bpm"
+N = 4
+out = model.generate(
+    [text] * N,
+    progress=True,
+)
+
+# Write to files
+dt_str = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+for i in range(N):
+    audio_write(
+        out_dir / f"{dt_str}_{i:02d}",
+        out[i].cpu(),
+        model.sample_rate,
+        strategy="loudness",
+    )
+
+# Or, if in a notebook, display audio widgets
+# display_audio(out, model.sample_rate)
+```