Update README.md

README.md

@@ -36,4 +36,55 @@ The included emotions are:
 </pre>
 
 - Library: https://github.com/tiantiaf0627/vox-profile-release
-- Docs: [More Information Needed]
+
+# How to use this model
+
+## Download repo
+```
+git clone [email protected]:tiantiaf0627/vox-profile-release.git
+```
+## Install the package
+```
+conda create -n vox_profile python=3.8
+cd vox-profile-release
+pip install -e .
+```
+
+## Load the model
+```
+# Load libraries
+import torch
+import torch.nn.functional as F
+from src.model.emotion.whisper_emotion import WhisperWrapper
+# Find device
+device = torch.device("cuda") if torch.cuda.is_available() else "cpu"
+# Load model from Huggingface
+model = WhisperWrapper.from_pretrained("tiantiaf/whisper-large-v3-msp-podcast-emotion").to(device)
+model.eval()
+```
+
+## Prediction
+```
+# Label List
+emotion_label_list = [
+    'Anger', 
+    'Contempt', 
+    'Disgust', 
+    'Fear', 
+    'Happiness', 
+    'Neutral', 
+    'Sadness', 
+    'Surprise', 
+    'Other'
+]
+    
+# Load data, here just zeros as the example, audio data should be 16kHz mono channel
+data = torch.zeros([1, 16000]).float().to(device)
+logits, embedding, _, _, _, _ = wavlm_model(
+    data, return_feature=True
+)
+    
+# Probability and output
+emotion_prob = F.softmax(logits, dim=1)
+print(emotion_label_list[torch.argmax(emotion_prob).detach().cpu().item()])
+```