add instructions

main.py

@@ -27,6 +27,166 @@ On 🌐Github: [Tonic-AI](https://github.com/tonic-ai) & contribute to🌟 [Mult
 🤗Big thanks to Yuvi Sharma and all the folks at huggingface for the community grant 🤗
 """
 
+useage_instructions = """
+## Overview
+JASCO is a powerful text-to-music generation system that allows you to create music using text descriptions and various controls including chords, drums, and melody. This guide explains how to use each feature of the interface.
+
+## Model Selection
+Four different models are available:
+1. `facebook/jasco-chords-drums-400M` - Basic model with chord and drum support (400M parameters)
+2. `facebook/jasco-chords-drums-1B` - Enhanced model with chord and drum support (1B parameters)
+3. `facebook/jasco-chords-drums-melody-400M` - Model with melody support (400M parameters)
+4. `facebook/jasco-chords-drums-melody-1B` - Full-featured model with melody support (1B parameters)
+
+## Input Controls
+
+### 1. Text Description
+- Enter a descriptive text about the music you want to generate
+- Examples:
+  - "80s pop with groovy synth bass and electric piano"
+  - "Strings, woodwind, orchestral, symphony"
+  - "Jazz quartet with walking bass and smooth piano"
+
+### 2. Chord Progression
+Format: `(Chord, Time), (Chord, Time), ...`
+- Time is in seconds (0-10 seconds range)
+- Example: `(C, 0.0), (D, 2.0), (F, 4.0), (Ab, 6.0), (Bb, 7.0), (C, 8.0)`
+
+Supported chord types:
+```python
+Basic Chords: C, D, E, F, G, A, B
+Minor Chords: Cm, Dm, Em, Fm, Gm, Am, Bm
+Seventh Chords: C7, D7, E7, F7, G7, A7, B7
+Major Seventh: Cmaj7, Dmaj7, Emaj7, Fmaj7, Gmaj7, Amaj7, Bmaj7
+Minor Seventh: Cm7, Dm7, Em7, Fm7, Gm7, Am7, Bm7
+Flat Chords: Ab, Bb (and their variations)
+Special: N (No chord/silence)
+```
+
+### 3. Drums Input
+Two options for adding drums:
+1. File Upload:
+   - Select "file" in Drums Input Source
+   - Upload a WAV file containing drum patterns
+   - Recommended length: 2-4 bars
+
+2. Microphone Recording:
+   - Select "mic" in Drums Input Source
+   - Record drum patterns using your microphone
+   - Keep recordings short and rhythmic
+
+### 4. Melody Input
+- Upload a melody salience matrix as a PyTorch tensor
+- Format: Shape [n_melody_bins, T]
+- File should be saved using `torch.save()`
+
+### 5. Generation Parameters
+
+#### Classifier Free Guidance (CFG) Controls:
+- CFG ALL: Controls overall adherence to input conditions (default: 1.25)
+  - Range: 1.0-3.0
+  - Higher values = stronger conditioning
+
+- CFG TEXT: Controls text conditioning strength (default: 2.5)
+  - Range: 1.0-4.0
+  - Higher values = closer match to text description
+
+#### ODE Parameters:
+- ODE Solver: Choose between 'euler' and 'dopri5'
+  - euler: Faster, less accurate
+  - dopri5: Slower, more accurate
+
+- ODE Tolerance: Numerical precision (default: 1e-4)
+  - Lower values = higher precision, slower generation
+
+- Euler Steps: Number of steps for euler solver (default: 10)
+  - Higher values = more accurate, slower generation
+
+## Generation Process
+
+1. Select a model based on your needs:
+   - Use 400M models for faster generation
+   - Use 1B models for higher quality
+   - Choose melody-enabled models if using melody input
+
+2. Enter your text description
+
+3. Input chord progression:
+```
+Example:
+(C, 0.0), (Am, 2.5), (F, 5.0), (G, 7.5)
+```
+
+4. (Optional) Add drums via file upload or microphone
+
+5. (Optional) Upload melody matrix
+
+6. Adjust generation parameters or use defaults
+
+7. Click "Make Musix"
+
+## Output
+- The system generates two variations of your music
+- Each generation is 10 seconds long
+- Output is provided as WAV files
+- You can download or play directly in the interface
+
+## Tips for Best Results
+
+1. Text Descriptions:
+   - Be specific about instruments
+   - Include genre information
+   - Mention desired mood or style
+
+2. Chord Progressions:
+   - Use common progressions for better results
+   - Space chords evenly
+   - Include resolution points
+
+3. Drums:
+   - Use clean, clear drum patterns
+   - Avoid complex patterns for better results
+   - Keep volume levels consistent
+
+4. Memory Management:
+   - The interface caches models after first use
+   - Switch models only when necessary
+   - Clear browser cache if experiencing issues
+
+## Example Usage
+
+```python
+# Example 1: Pop Music
+Text: "Upbeat pop song with electric piano and synthesizer"
+Chords: (C, 0.0), (Am, 2.5), (F, 5.0), (G, 7.5)
+Model: facebook/jasco-chords-drums-400M
+
+# Example 2: Orchestral
+Text: "Epic orchestral piece with strong strings and brass"
+Chords: (Cm, 0.0), (G, 3.0), (Bb, 6.0), (Cm, 8.0)
+Model: facebook/jasco-chords-drums-melody-1B
+
+# Example 3: Jazz
+Text: "Smooth jazz quartet with walking bass and piano"
+Chords: (Dmaj7, 0.0), (Em7, 2.5), (A7, 5.0), (Dmaj7, 7.5)
+Model: facebook/jasco-chords-drums-1B
+```
+
+## Error Handling
+- If generation fails, try:
+  1. Simplifying chord progressions
+  2. Reducing CFG values
+  3. Using simpler text descriptions
+  4. Checking input format compliance
+  5. Refreshing the page
+
+## Performance Considerations
+- First generation may be slower due to model loading
+- Subsequent generations with same model are faster
+- Higher parameter models (1B) require more memory
+- Melody-enabled models may be slower
+"""
+
 hf_token = os.environ.get('HFTOKEN')
 if hf_token:
     login(token=hf_token)
@@ -275,6 +435,9 @@ with gr.Blocks() as demo:
         with gr.Column():
             with gr.Group():
                 gr.Markdown(join_us)
+    with gr.Row():
+        with gr.Accordion(open=False, label="Useage Instructions"):
+            gr.Markdown(useage_instructions)
 
     with gr.Row():
         with gr.Column():