add README

README.md

@@ -0,0 +1,131 @@
+---
+license: apache-2.0
+pipeline_tag: text-to-speech
+language:
+- en
+tags:
+- model_hub_mixin
+- pytorch_model_hub_mixin
+widget:
+- text: "[S1] Dia is an open weights text to dialogue model. [S2] You get full control over scripts and voices. [S1] Wow. Amazing. (laughs) [S2] Try it now on Git hub or Hugging Face."
+  example_title: "Dia intro"
+- text: "[S1] Oh fire! Oh my goodness! What's the procedure? What to we do people? The smoke could be coming through an air duct! [S2] Oh my god! Okay.. it's happening. Everybody stay calm! [S1] What's the procedure... [S2] Everybody stay fucking calm!!!... Everybody fucking calm down!!!!! [S1] No! No! If you touch the handle, if its hot there might be a fire down the hallway!"
+  example_title: "Panic protocol"
+---
+
+<center>
+<a href="https://github.com/nari-labs/dia">
+<img src="https://github.com/nari-labs/dia/raw/main/dia/static/images/banner.png">
+</a>
+</center>
+
+Dia is a 1.6B parameter text to speech model created by Nari Labs. It was pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration.
+
+Dia **directly generates highly realistic dialogue from a transcript**. You can condition the output on audio, enabling emotion and tone control. The model can also produce nonverbal communications like laughter, coughing, clearing throat, etc.
+
+To accelerate research, we are providing access to pretrained model checkpoints and inference code. The model weights are hosted on [Hugging Face](https://huggingface.co/nari-labs/Dia-1.6B). The model only supports English generation at the moment.
+
+We also provide a [demo page](https://yummy-fir-7a4.notion.site/dia) comparing our model to [ElevenLabs Studio](https://elevenlabs.io/studio) and [Sesame CSM-1B](https://github.com/SesameAILabs/csm).
+
+- (Update) We have a ZeroGPU Space running! Try it now [here](https://huggingface.co/spaces/nari-labs/Dia-1.6B). Thanks to the HF team for the support :)
+- Join our [discord server](https://discord.gg/bJq6vjRRKv) for community support and access to new features.
+- Play with a larger version of Dia: generate fun conversations, remix content, and share with friends. 🔮 Join the [waitlist](https://tally.so/r/meokbo) for early access.
+
+## ⚡️ Quickstart
+
+This will open a Gradio UI that you can work on.
+
+```bash
+git clone https://github.com/nari-labs/dia.git
+cd dia && uv run app.py
+```
+
+or if you do not have `uv` pre-installed:
+
+```bash
+git clone https://github.com/nari-labs/dia.git
+cd dia
+python -m venv .venv
+source .venv/bin/activate
+pip install uv
+uv run app.py
+```
+
+Note that the model was not fine-tuned on a specific voice. Hence, you will get different voices every time you run the model.
+You can keep speaker consistency by either adding an audio prompt (a guide coming VERY soon - try it with the second example on Gradio for now), or fixing the seed.
+
+## Features
+
+- Generate dialogue via `[S1]` and `[S2]` tag
+- Generate non-verbal like `(laughs)`, `(coughs)`, etc.
+  - Below verbal tags will be recognized, but might result in unexpected output.
+  - `(laughs), (clears throat), (sighs), (gasps), (coughs), (singing), (sings), (mumbles), (beep), (groans), (sniffs), (claps), (screams), (inhales), (exhales), (applause), (burps), (humming), (sneezes), (chuckle), (whistles)`
+- Voice cloning. See [`example/voice_clone.py`](example/voice_clone.py) for more information.
+  - In the Hugging Face space, you can upload the audio you want to clone and place its transcript before your script. Make sure the transcript follows the required format. The model will then output only the content of your script.
+
+## ⚙️ Usage
+
+### As a Python Library
+
+```python
+import soundfile as sf
+
+from dia.model import Dia
+
+
+model = Dia.from_pretrained("nari-labs/Dia-1.6B")
+
+text = "[S1] Dia is an open weights text to dialogue model. [S2] You get full control over scripts and voices. [S1] Wow. Amazing. (laughs) [S2] Try it now on Git hub or Hugging Face."
+
+output = model.generate(text)
+
+sf.write("simple.mp3", output, 44100)
+```
+
+A pypi package and a working CLI tool will be available soon.
+
+## 💻 Hardware and Inference Speed
+
+Dia has been tested on only GPUs (pytorch 2.0+, CUDA 12.6). CPU support is to be added soon.
+The initial run will take longer as the Descript Audio Codec also needs to be downloaded.
+
+On enterprise GPUs, Dia can generate audio in real-time. On older GPUs, inference time will be slower.
+For reference, on a A4000 GPU, Dia roughly generates 40 tokens/s (86 tokens equals 1 second of audio).
+`torch.compile` will increase speeds for supported GPUs.
+
+The full version of Dia requires around 10GB of VRAM to run. We will be adding a quantized version in the future.
+
+If you don't have hardware available or if you want to play with bigger versions of our models, join the waitlist [here](https://tally.so/r/meokbo).
+
+## 🪪 License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## ⚠️ Disclaimer
+
+This project offers a high-fidelity speech generation model intended for research and educational use. The following uses are **strictly forbidden**:
+
+- **Identity Misuse**: Do not produce audio resembling real individuals without permission.
+- **Deceptive Content**: Do not use this model to generate misleading content (e.g. fake news)
+- **Illegal or Malicious Use**: Do not use this model for activities that are illegal or intended to cause harm.
+
+By using this model, you agree to uphold relevant legal standards and ethical responsibilities. We **are not responsible** for any misuse and firmly oppose any unethical usage of this technology.
+
+## 🔭 TODO / Future Work
+
+- Docker support.
+- Optimize inference speed.
+- Add quantization for memory efficiency.
+
+## 🤝 Contributing
+
+We are a tiny team of 1 full-time and 1 part-time research-engineers. We are extra-welcome to any contributions!
+Join our [Discord Server](https://discord.gg/bJq6vjRRKv) for discussions.
+
+## 🤗 Acknowledgements
+
+- We thank the [Google TPU Research Cloud program](https://sites.research.google/trc/about/) for providing computation resources.
+- Our work was heavily inspired by [SoundStorm](https://arxiv.org/abs/2305.09636), [Parakeet](https://jordandarefsky.com/blog/2024/parakeet/), and [Descript Audio Codec](https://github.com/descriptinc/descript-audio-codec).
+- HuggingFace for providing the ZeroGPU Grant.
+- "Nari" is a pure Korean word for lily.
+- We thank Jason Y. for providing help with data filtering.