Update README.md

README.md

@@ -31,4 +31,50 @@ The included English accents are:
 
 
 - 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.accent.whisper_accent 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-narrow-accent").to(device)
+model.eval()
+```
+
+## Prediction
+```
+# Label List
+english_accent_list = [
+    'East Asia', 'English', 'Germanic', 'Irish', 
+    'North America', 'Northern Irish', 'Oceania', 
+    'Other', 'Romance', 'Scottish', 'Semitic', 'Slavic', 
+    'South African', 'Southeast Asia', 'South Asia', 'Welsh'
+]
+    
+# Load data, here just zeros as the example, audio data should be 16kHz mono channel
+data = torch.zeros([1, 16000]).float().to(device)
+logits, embeddings = model(data, return_feature=True)
+    
+# Probability and output
+accent_prob = F.softmax(logits, dim=1)
+print(english_accent_list[torch.argmax(accent_prob).detach().cpu().item()])
+```