radiogroup-crits commited on
Commit
867f019
1 Parent(s): 3d73e67

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +17 -2
README.md CHANGED
@@ -40,17 +40,32 @@ Our language model was generated using a dataset of Italian wikipedia articles a
40
 
41
 
42
  ## Download CommonVoice8.0 dataset for italian language
43
-
44
  from datasets import load_dataset
45
 
46
  dataset = load_dataset("mozilla-foundation/common_voice_8_0", "it", use_auth_token=True)
47
-
48
 
49
  ## Evaluation Commands
50
 
51
  To evaluate on `mozilla-foundation/common_voice_8_0` with split `test`:
52
 
 
53
  python eval.py --model_id radiogroup-crits/wav2vec2-xls-r-1b-italian-doc4lm-5gram --dataset mozilla-foundation/common_voice_8_0 --config it --split test --log_outputs --greedy
54
  mv log_mozilla-foundation_common_voice_8_0_it_test_predictions.txt log_mozilla-foundation_common_voice_8_0_it_test_predictions_greedy.txt
55
  mv mozilla-foundation_common_voice_8_0_it_test_eval_results.txt mozilla-foundation_common_voice_8_0_it_test_eval_results_greedy.txt
 
 
 
 
56
 
 
 
 
 
 
 
 
 
 
 
 
40
 
41
 
42
  ## Download CommonVoice8.0 dataset for italian language
43
+ ```python
44
  from datasets import load_dataset
45
 
46
  dataset = load_dataset("mozilla-foundation/common_voice_8_0", "it", use_auth_token=True)
47
+ ```
48
 
49
  ## Evaluation Commands
50
 
51
  To evaluate on `mozilla-foundation/common_voice_8_0` with split `test`:
52
 
53
+ ```bash
54
  python eval.py --model_id radiogroup-crits/wav2vec2-xls-r-1b-italian-doc4lm-5gram --dataset mozilla-foundation/common_voice_8_0 --config it --split test --log_outputs --greedy
55
  mv log_mozilla-foundation_common_voice_8_0_it_test_predictions.txt log_mozilla-foundation_common_voice_8_0_it_test_predictions_greedy.txt
56
  mv mozilla-foundation_common_voice_8_0_it_test_eval_results.txt mozilla-foundation_common_voice_8_0_it_test_eval_results_greedy.txt
57
+ ```
58
+
59
+ ## Citation
60
+ If you want to cite this model you can use this:
61
 
62
+ ```bibtex
63
+ @misc{radiogroup-crits2022wav2vec2-xls-r-1b-italian-doc4lm-5gram,
64
+ title={XLS-R Wav2Vec2 Italian by radiogroup-crits},
65
+ author={Raffaele Teraoni Prioletti and Paolo Casagranda and Francesco Russo},
66
+ publisher={Hugging Face},
67
+ journal={Hugging Face Hub},
68
+ howpublished={\url{https://huggingface.co/radiogroup-crits/wav2vec2-xls-r-1b-italian-doc4lm-5gram}},
69
+ year={2022}
70
+ }
71
+ ```