manoskary commited on
Commit
a7f1eb3
·
verified ·
1 Parent(s): d8a9127

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +51 -4
README.md CHANGED
@@ -1,14 +1,61 @@
1
  ---
2
  title: NotaGen Inference
3
- emoji: 🌍
4
  colorFrom: blue
5
  colorTo: purple
6
  sdk: gradio
7
- sdk_version: 5.48.0
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
- short_description: Generate symbolic music in ABC notation using NotaGen.
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: NotaGen Inference
3
+ emoji: 🎵
4
  colorFrom: blue
5
  colorTo: purple
6
  sdk: gradio
7
+ sdk_version: 4.0.0
8
  app_file: app.py
9
  pinned: false
10
  license: mit
 
11
  ---
12
 
13
+ # NotaGen - Symbolic Music Generation
14
+
15
+ Generate symbolic music in ABC notation using NotaGen.
16
+
17
+ This space provides an API endpoint (`/infer`) for remote inference without local computation.
18
+
19
+ ## Usage
20
+
21
+ ### Web Interface
22
+ Simply enter the musical period, composer style, and instrumentation, then click "Generate ABC Notation".
23
+
24
+ ### API Access
25
+
26
+ ```python
27
+ from gradio_client import Client
28
+
29
+ client = Client("https://huggingface.co/spaces/<your-username>/<space-name>")
30
+
31
+ result = client.predict(
32
+ period="Classical",
33
+ composer="Mozart",
34
+ instrumentation="Piano",
35
+ api_name="/infer"
36
+ )
37
+
38
+ print(result) # ABC notation string
39
+ ```
40
+
41
+ ## Parameters
42
+
43
+ - **period**: Musical period (e.g., Classical, Romantic, Baroque)
44
+ - **composer**: Composer style (e.g., Mozart, Chopin, Bach)
45
+ - **instrumentation**: Instruments (e.g., Piano, Violin, Orchestra)
46
+
47
+ ## Output
48
+
49
+ Returns ABC notation as a plain text string. This can be converted to PDF, XML, MIDI, etc. using WeaveMuse or other ABC processing tools.
50
+
51
+ ## Integration
52
+
53
+ This space is designed to work with [WeaveMuse](https://github.com/manoskary/weavemuse) for remote music generation without local GPU computation.
54
+
55
+ ## Model
56
+
57
+ Uses the NotaGen model for symbolic music generation.
58
+
59
+ ## License
60
+
61
+ MIT License