Upload README.md with huggingface_hub

README.md

@@ -1,16 +1,48 @@
 ---
 license: mit
+library_name: softchart
 tags:
-- audio-to-symbolic
+- taiko
+- rhythm-game
 - chart-generation
-- model_hub_mixin
 - music
-- pytorch_model_hub_mixin
-- rhythm-game
-- taiko
+- audio-to-symbolic
+pipeline_tag: audio-to-audio
 ---
 
-This model has been pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration:
-- Code: https://github.com/JacobLinCool/SoftChart
-- Paper: [More Information Needed]
-- Docs: [More Information Needed]
+# SoftChart Generator
+
+An 8.1M-parameter encoder–decoder Transformer that generates **Taiko no Tatsujin**
+charts from music. Given a log-mel spectrogram and conditions (difficulty, density,
+and an optional song-level plan), it autoregressively produces a sequence of timed
+chart events. Part of the [SoftChart](https://github.com/JacobLinCool/SoftChart) system.
+
+This checkpoint (`pr12`) supports: **course/level/density conditioning, prev-window
+context, easy⊂hard sibling hints, style codes, and song-level plan control**
+(density envelope, breathing gaps, climax placement). Perfect difficulty
+monotonicity (Spearman 1.0) and controllable "same song → multiple valid charts".
+
+## Usage
+
+```python
+from softchart.hf import SoftChartGenerator
+from softchart.generate import load_hf, generate_song
+
+model = load_hf("JacobLinCool/softchart-generator", device="cuda")
+# mel: (128, T) log-mel at 22050 Hz, hop 256
+chart = generate_song(model, mel, course="oni", level=9, density_bucket=7, greedy=True)
+# chart["hits"] = [{"t": seconds, "type": "don"/"ka"/...}, ...]
+```
+
+Full audio→chart→TJA pipeline: [`scripts/infer.py`](https://github.com/JacobLinCool/SoftChart)
+or the [demo Space](https://huggingface.co/spaces/JacobLinCool/softchart).
+
+## Companion models
+
+- [softchart-planner](https://huggingface.co/JacobLinCool/softchart-planner) — audio → song-level plan
+- [softchart-beat](https://huggingface.co/JacobLinCool/softchart-beat) — beat/downbeat for barline anchoring
+
+## License & data note
+
+Code and weights are **MIT**. Trained on charts derived from a commercial game;
+released for research and personal use.