nii-yamagishilab commited on
Commit
2a5c4c4
Β·
verified Β·
1 Parent(s): e422957

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -17
README.md CHANGED
@@ -10,9 +10,9 @@ base_model:
10
  - facebook/wav2vec2-xls-r-2b
11
  ---
12
 
13
- # πŸ” **SSL-AntiDeepfake**
14
 
15
- The **SSL-AntiDeepfake** project provides a series of powerful self-supervised learning (SSL) models crafted to **detect deepfake speech** with state-of-the-art accuracy.
16
 
17
 
18
  # πŸ€– Available Models
@@ -32,8 +32,7 @@ All models are released on Hugging Face πŸ€— with two variants:
32
  | Hubert-Extra-Large-AntiDeepfake | [Default](https://huggingface.co/nii-yamagishilab/hubert-xlarge-anti-deepfake), [NDA](https://huggingface.co/nii-yamagishilab/hubert-xlarge-anti-deepfake-nda)
33
 
34
  # πŸ› οΈ Training Code & Repository
35
- Explore training scripts, config files, and evaluation utilities in our GitHub repository:πŸ”— [SSL-AntiDeepfake GitHub Repository](https://github.com/nii-yamagishilab/Ultra-SSL-AntiDeepfake)
36
-
37
 
38
  # πŸš€ **Model Spotlight: XLS-R-2B-AntiDeepfake-NDA**
39
 
@@ -56,18 +55,23 @@ Explore training scripts, config files, and evaluation utilities in our GitHub r
56
 
57
  # πŸš€ **Inference with PyTorch**
58
 
59
- ⚠️ **Important:**
60
- To run inference with this model, you need to install a specific version of `fairseq` and make manual code modifications. For detailed instructions, please refer to the installation guide in our [GitHub repository](https://github.com/nii-yamagishilab/Ultra-SSL-AntiDeepfake).
61
-
62
- βœ… **Easier Alternatives:**
63
- We recommend these models for plug-and-play inference:
64
- - [MMS-300M-AntiDeepfake](https://huggingface.co/nii-yamagishilab/mms-300m-anti-deepfake)
65
- - [MMS-1B-AntiDeepfake](https://huggingface.co/nii-yamagishilab/mms-1b-anti-deepfake)
66
-
67
- πŸ“¦ Dependencies after installing fairseq:
68
  ```
69
- pip install huggingface-hub safetensors soundfile
70
- (pip install huggingface-hub==0.31.1 safetensors==0.5.3 soundfile==0.13.1)
 
 
 
 
 
 
 
 
 
 
 
 
 
71
  ```
72
 
73
  πŸš€ Inference:
@@ -178,7 +182,7 @@ for file_name, prob in results:
178
  print(f"{file_name}: real prob = {prob[1]:.3f}, fake prob = {prob[0]:.3f}")
179
  ```
180
  # πŸ“Š **Performance Metrics**
181
- Results shown below can be reproduced using scripts provided in our [GitHub repository](https://github.com/nii-yamagishilab/Ultra-SSL-AntiDeepfake).
182
 
183
  | Test Database | ROC AUC | Accuracy | Precision | Recall | F1-score | FPR | FNR | EER (%) @ Threshold |
184
  |---------------------|---------|----------|-----------|--------|----------|-------|-------|----------------------|
@@ -229,7 +233,7 @@ Below is a breakdown of the training set used for fine-tuning.
229
  | Train Set | Over 100 languages| 56370.00 | 18280.00 |
230
 
231
  # **Attribution**
232
- All SSL-AntiDeepfake models were developed by [Yamagishi Lab](https://yamagishilab.jp/) at the National Institute of Informatics (NII), Japan.
233
 
234
  All model weights are the intellectual property of NII and are made available for research and educational purposes under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license.
235
 
 
10
  - facebook/wav2vec2-xls-r-2b
11
  ---
12
 
13
+ # πŸ” **AntiDeepfake**
14
 
15
+ The **AntiDeepfake** project provides a series of powerful self-supervised learning (SSL) models crafted to **detect deepfake speech** with state-of-the-art accuracy.
16
 
17
 
18
  # πŸ€– Available Models
 
32
  | Hubert-Extra-Large-AntiDeepfake | [Default](https://huggingface.co/nii-yamagishilab/hubert-xlarge-anti-deepfake), [NDA](https://huggingface.co/nii-yamagishilab/hubert-xlarge-anti-deepfake-nda)
33
 
34
  # πŸ› οΈ Training Code & Repository
35
+ Explore training scripts, config files, and evaluation utilities in our GitHub repository:πŸ”— [AntiDeepfake GitHub Repository](https://github.com/nii-yamagishilab/AntiDeepfake)
 
36
 
37
  # πŸš€ **Model Spotlight: XLS-R-2B-AntiDeepfake-NDA**
38
 
 
55
 
56
  # πŸš€ **Inference with PyTorch**
57
 
58
+ πŸ“¦ Dependencies:
 
 
 
 
 
 
 
 
59
  ```
60
+ ### New conda environments ###
61
+ conda create --name antideepfake python==3.9.0
62
+ conda activate antideepfake
63
+ conda install pip==24.0
64
+
65
+ ### Install Fariseq ###
66
+ # fairseq 0.10.2 on pip does not work
67
+ git clone https://github.com/pytorch/fairseq
68
+ cd fairseq
69
+ # checkout this specific commit. Latest commit does not work
70
+ git checkout 862efab86f649c04ea31545ce28d13c59560113d
71
+ pip install --editable .
72
+
73
+ ### Install other packages ###
74
+ pip install huggingface-hub==0.31.1 safetensors==0.5.3 soundfile==0.13.1 numpy==1.21.2
75
  ```
76
 
77
  πŸš€ Inference:
 
182
  print(f"{file_name}: real prob = {prob[1]:.3f}, fake prob = {prob[0]:.3f}")
183
  ```
184
  # πŸ“Š **Performance Metrics**
185
+ Results shown below can be reproduced using scripts provided in our [GitHub repository](https://github.com/nii-yamagishilab/AntiDeepfake).
186
 
187
  | Test Database | ROC AUC | Accuracy | Precision | Recall | F1-score | FPR | FNR | EER (%) @ Threshold |
188
  |---------------------|---------|----------|-----------|--------|----------|-------|-------|----------------------|
 
233
  | Train Set | Over 100 languages| 56370.00 | 18280.00 |
234
 
235
  # **Attribution**
236
+ All AntiDeepfake models were developed by [Yamagishi Lab](https://yamagishilab.jp/) at the National Institute of Informatics (NII), Japan.
237
 
238
  All model weights are the intellectual property of NII and are made available for research and educational purposes under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license.
239