Add resource/tool for showing available chords

app.py

@@ -1,4 +1,6 @@
 import logging
+from typing import Optional
+
 import gradio as gr
 import faiss
 import joblib
@@ -8,6 +10,8 @@ from datasets import load_dataset
 import json
 import os
 
+from gradio_client.exceptions import AppError
+
 from src.convert import get_embeddings_from_chord_sequences, get_embedding_from_filepaths
 from src.analysis import EmbeddingsAnalysis
 import cfg
@@ -41,6 +45,8 @@ def _parse_chord_input(chord_text):
     else:
         chords = chord_text.split()
 
+    # Remove consecutive duplicates
+    chords = [c for i, c in enumerate(chords) if i == 0 or c != chords[i - 1]]
     return chords
 
 
@@ -83,16 +89,36 @@ def _perform_analysis(embeddings, sequence_lengths, neighbour_embeddings=None):
     return score, neighbours_dict
 
 
-def analyze_chord_sequence_text(chord_text: str) -> tuple[float, list[dict]]:
+def _get_supported_chord_formats() -> str:
+    return (
+        "Roots: A, Ab, B, Bb, C, C#, D, Eb, E, F, F#, G\n"
+        "Modifiers: m, m7, maj7, m7b5, aug, dim, 6, 7, and slash chords (e.g. C/Bb, C/G)\n"
+        "Example chords for C: C, C/Bb, C/D, C/E, C/G, C6, C7, C7/E, Caug, Cdim, Cmaj7, Cm, Cm6, Cm7, Cm7b5, Cm7b5/Bb"
+    )
+
+
+@gr.mcp.resource("chords://supported-formats")
+def supported_chord_formats() -> str:
+    """Supported chord roots and modifiers for use with the analyze_chord_sequence_text tool."""
+    return _get_supported_chord_formats()
+
+
+
+def get_supported_chord_formats() -> str:
+    """Returns supported chord roots and modifiers for use with the analyze_chord_sequence_text tool."""
+    return _get_supported_chord_formats()
+
+
+def analyze_chord_sequence_text(chord_text: str) -> tuple[Optional[float], Optional[list[dict]]]:
     """
     Analyze a chord sequence from text input. Analysis is in the form of
     an originality score and a list of similar songs from a non-exhaustive
     sample set of songs in the system data store.
 
     Args:
-        chord_text: Chord sequence input as text (comma-separated or space-separated). IMPORTANT: Unless length is explicitly specified, for accurate results, provide the complete sequence of chords that would feature in a typical song, e.g. "C, Am, F, G, C, Am, F, G, C, Am, F, G, C, Am, F, G, ..." NOT just "C, Am, F, G". This could be 20-30 chords for a three minute song.
+        chord_text: Chord sequence as text (comma or space separated). Consult the chords://supported-formats resource (or the get_supported_chord_formats tool if resource access is unavailable) for supported chord names. IMPORTANT: Unless length is explicitly specified, for accurate results, provide the complete sequence of chords that would feature in a typical song, e.g. "C, Am, F, G, C, Am, F, G, ..." NOT just "C, Am, F, G". This could be 20-30 chords for a three minute song.
     Returns:
-        tuple[float, list[dict]]: Originality score and list of dictionaries, each representing a similar song. You may infer that some items in the list are essentially the same song - if so don't repeat them to the user. Also some songs are more famous than others in the results - if you come across a famous one, then highlight it.
+        tuple[float, list[dict]]: Originality score and list of dictionaries, each representing a similar song. You may infer that some items in the list are essentially the same song - if so don't repeat them to the user. Also some songs are more famous than others in the results - if you come across a famous one, then highlight it. Returns None results if there was error, likely due to wrong chord format.
     """
     logging.info(f"Analyzing chord sequence: {chord_text}")
     try:
@@ -106,7 +132,7 @@ def analyze_chord_sequence_text(chord_text: str) -> tuple[float, list[dict]]:
             neighbour_embeddings = get_embeddings_from_chord_sequences([padded_chords])
         score, neighbours = _perform_analysis(embeddings, [len(chords)], neighbour_embeddings)
         return score, neighbours
-    except Exception as e:
+    except AppError as e:
         logger.error(f"Error analyzing chord sequence: {e}")
         return None, None
 
@@ -157,15 +183,11 @@ def _format_music_analysis_for_ui(audio_file):
     file_info_text = f"**File analyzed:** {file_info}" if file_info else ""
     return file_info_text, scores_text, neighbours_text
 
-_preamble = """
-Enter chords separated by commas or spaces. Chords are expressed with a root note followed by a modifier without a space.
-
-Available roots: A, Ab, B, Bb, C, C#, D, Eb, E, F, F#, G\n
-Available modifiers: m, m7, maj7, m7b5, aug, dim, 6, 7, certain slash chords.
-
-For example, the following are all recognised chords for C:\n  
-C, C/Bb, C/D, C/E, C/G, C6, C7, C7/E, Caug, Cdim, Cmaj7, Cm, Cm6, Cm7, Cm7b5, Cm7b5/Bb 
-"""
+_preamble = (
+    "Enter chords separated by commas or spaces. "
+    "Chords are expressed with a root note followed by a modifier without a space.\n\n"
+    + _get_supported_chord_formats()
+)
 
 # Create Gradio interface
 with gr.Blocks(title="Harmonic Analysis Tool", theme=gr.themes.Soft()) as app:
@@ -257,13 +279,14 @@ with gr.Blocks(title="Harmonic Analysis Tool", theme=gr.themes.Soft()) as app:
         outputs=[gr.Textbox(visible=False), gr.Number(visible=False), gr.JSON(visible=False)],
         api_name="analyze_music_file"
     )
-    
-    # Allow Enter key to trigger analysis
-    # chord_input.submit(
-    #     fn=analyze_chord_sequence,
-    #     inputs=[chord_input],
-    #     outputs=[scores_output, neighbours_output]
-    # )
+
+    gr.Textbox(visible=False).change(
+        fn=get_supported_chord_formats,
+        inputs=[],
+        outputs=[gr.Textbox(visible=False)],
+        api_name="get_supported_chord_formats"
+    )
+
 
 if __name__ == "__main__":
     app.launch(

cfg.py

@@ -3,7 +3,7 @@ LABELS_LOCATION = './assets/all_labels.csv'
 LOOKUP_DS_NAME = 'ohollo/lmd_chords'
 CLOSE_THRESHOLD = 0.9
 SCALER_DICT_LOCATION = './assets/quantile_transformers.joblib'
-MIN_SEQUENCE_LENGTH_FOR_NEIGHBOURS = 24
+MIN_SEQUENCE_LENGTH_FOR_NEIGHBOURS = 18
 HOW_IT_WORKS_MD_LOCATION = './how_it_works.md'
 RADII = (0.8, 0.85, 0.9, 0.925, 0.95)
 # RADII = (0.9, 0.925, 0.95, 0.975, 0.99)