Add readme from riffusion/riffusion-model-v1

README.md

@@ -1,3 +1,95 @@
 ---
 license: creativeml-openrail-m
+tags:
+- stable-diffusion
+- stable-diffusion-diffusers
+- text-to-audio
+inference: true
+extra_gated_prompt: >-
+  This model is open access and available to all, with a CreativeML OpenRAIL-M
+  license further specifying rights and usage.
+
+  The CreativeML OpenRAIL License specifies: 
+
+
+  1. You can't use the model to deliberately produce nor share illegal or
+  harmful outputs or content 
+
+  2. Riffusion claims no rights on the outputs you generate, you are free to use
+  them and are accountable for their use which must not go against the
+  provisions set in the license
+
+  3. You may re-distribute the weights and use the model commercially and/or as
+  a service. If you do, please be aware you have to include the same use
+  restrictions as the ones in the license and share a copy of the CreativeML
+  OpenRAIL-M to all your users (please read the license entirely and carefully)
+
+  Please read the full license carefully here:
+  https://huggingface.co/spaces/CompVis/stable-diffusion-license
+      
+extra_gated_heading: Please read the LICENSE to access this model
+library_name: diffusers
 ---
+
+# Riffusion
+
+Riffusion is an app for real-time music generation with stable diffusion.
+
+Read about it at https://www.riffusion.com/about and try it at https://www.riffusion.com/.
+
+* Code: https://github.com/riffusion/riffusion
+* Web app: https://github.com/hmartiro/riffusion-app
+* Model checkpoint: https://huggingface.co/riffusion/riffusion-model-v1
+* Discord: https://discord.gg/yu6SRwvX4v
+
+This repository contains the model files, including:
+
+ * a diffusers formated library
+ * a compiled checkpoint file
+ * a traced unet for improved inference speed
+ * a seed image library for use with riffusion-app
+
+## Riffusion v1 Model
+
+Riffusion is a latent text-to-image diffusion model capable of generating spectrogram images given any text input. These spectrograms can be converted into audio clips.
+
+The model was created by [Seth Forsgren](https://sethforsgren.com/) and [Hayk Martiros](https://haykmartiros.com/) as a hobby project.
+
+You can use the Riffusion model directly, or try the [Riffusion web app](https://www.riffusion.com/).
+
+The Riffusion model was created by fine-tuning the **Stable-Diffusion-v1-5** checkpoint. Read about Stable Diffusion here [🤗's Stable Diffusion blog](https://huggingface.co/blog/stable_diffusion).
+
+### Model Details
+- **Developed by:** Seth Forsgren, Hayk Martiros
+- **Model type:** Diffusion-based text-to-image generation model
+- **Language(s):** English
+- **License:** [The CreativeML OpenRAIL M license](https://huggingface.co/spaces/CompVis/stable-diffusion-license) is an [Open RAIL M license](https://www.licenses.ai/blog/2022/8/18/naming-convention-of-responsible-ai-licenses), adapted from the work that [BigScience](https://bigscience.huggingface.co/) and [the RAIL Initiative](https://www.licenses.ai/) are jointly carrying in the area of responsible AI licensing. See also [the article about the BLOOM Open RAIL license](https://bigscience.huggingface.co/blog/the-bigscience-rail-license) on which our license is based.
+- **Model Description:** This is a model that can be used to generate and modify images based on text prompts. It is a [Latent Diffusion Model](https://arxiv.org/abs/2112.10752) that uses a fixed, pretrained text encoder ([CLIP ViT-L/14](https://arxiv.org/abs/2103.00020)) as suggested in the [Imagen paper](https://arxiv.org/abs/2205.11487).
+
+### Direct Use 
+The model is intended for research purposes only. Possible research areas and
+tasks include
+
+- Generation of artworks, audio, and use in creative processes.
+- Applications in educational or creative tools.
+- Research on generative models.
+
+### Datasets
+The original Stable Diffusion v1.5 was trained on the [LAION-5B](https://arxiv.org/abs/2210.08402) dataset using the [CLIP text encoder](https://openai.com/blog/clip/), which provided an amazing starting point with an in-depth understanding of language, including musical concepts. The team at LAION also compiled a fantastic audio dataset from many general, speech, and music sources that we recommend at [LAION-AI/audio-dataset](https://github.com/LAION-AI/audio-dataset/blob/main/data_collection/README.md).
+
+### Fine Tuning
+
+Check out the [diffusers training examples](https://huggingface.co/docs/diffusers/training/overview) from Hugging Face. Fine tuning requires a dataset of spectrogram images of short audio clips, with associated text describing them. Note that the CLIP encoder is able to understand and connect many words even if they never appear in the dataset. It is also possible to use a [dreambooth](https://huggingface.co/blog/dreambooth) method to get custom styles.
+
+## Citation
+
+If you build on this work, please cite it as follows:
+
+```
+@article{Forsgren_Martiros_2022,
+  author = {Forsgren, Seth* and Martiros, Hayk*},
+  title = {{Riffusion - Stable diffusion for real-time music generation}},
+  url = {https://riffusion.com/about},
+  year = {2022}
+}
+```