Upload README.md

README.md

@@ -1,3 +1,62 @@
 ---
+language: en
 license: bsd-3-clause
+library_name: pytorch-lightning
+tags:
+- pytorch
+- pytorch-lightning
+- audio-upsampling
+datasets: vctk
+model_name: nu-wave-x2
 ---
+
+# nu-wave-x2
+
+## Model description
+
+
+NU-Wave: A Diffusion Probabilistic Model for Neural Audio Upsampling
+
+
+- [GitHub Repo](https://github.com/mindslab-ai/nuwave)
+- [Paper](https://arxiv.org/pdf/2104.02321.pdf)
+
+This model was trained by contributor Frederico S. Oliveira, who graciously [provided the checkpoint](https://github.com/mindslab-ai/nuwave/issues/18) in this repo in the original author's GitHub repo.
+
+This model was trained using source code written by Junhyeok Lee and Seungu Han under the BSD 3.0 License. All credit goes to them for this work.
+
+This model takes in audio at 24kHz and upsamples it to 48kHz.
+
+
+## Intended uses & limitations
+
+#### How to use
+
+```python
+# You can include sample code which will be formatted
+```
+
+#### Limitations and bias
+
+Provide examples of latent issues and potential remediations.
+
+## Training data
+
+Describe the data you used to train the model.
+If you initialized it with pre-trained weights, add a link to the pre-trained model card or repository with description of the pre-training data.
+
+## Training procedure
+
+Preprocessing, hardware used, hyperparameters...
+
+## Eval results
+
+Provide some evaluation results.
+
+### BibTeX entry and citation info
+
+```bibtex
+@inproceedings{...,
+  year={2020}
+}
+```