add usage

app.py

@@ -5,6 +5,7 @@ import gradio
 import gradio.inputs
 import gradio.outputs
 import matplotlib.pyplot as plt
+import markdown
 import numpy as np
 import torch
 from df import config
@@ -227,5 +228,6 @@ iface = gradio.Interface(
     description=description,
     layout="horizontal",
     allow_flagging="never",
+    article=markdown.markdown(open("usage.md").read()),
 )
 iface.launch(cache_examples=False)

requirements.txt

@@ -2,4 +2,5 @@ torch
 torchaudio
 deepfilternet
 matplotlib
+markdown
 gradio

usage.md

@@ -0,0 +1,13 @@
+**Usage:**
+
+This demo takes a speech sample and a noise sample and mixes them at the provided signal to noise ratio (SNR).
+You can either record a speech sample or alternatively provide one via upload.
+Furthermore, you may upload a noise sample which will be mixed with the speech sample.
+If no samples are provided, a default will be used.
+
+DeepFilterNet [(link)](https://github.com/Rikorose/DeepFilterNet) is used to denoise the noisy mixture.
+
+**Note:**
+
+Before you edit the inputs (i.e. record a new sample), you need to clear all inputs and outputs.
+Otherwise the output audio will not be updated.