sanchit-gandhi HF staff commited on
Commit
8d11d21
1 Parent(s): fc97344

cli instructions

Browse files
Files changed (1) hide show
  1. README.md +22 -1
README.md CHANGED
@@ -17,7 +17,7 @@ with the OpenAI Whisper long-form transcription algorithm. In our benchmark over
17
  outperformed distil-large-v2 by 5% WER average. Thus, you can expect significant performance gains by switching to this
18
  latest checkpoint.
19
 
20
- ## Usage
21
 
22
  To use the model in the original Whisper format, first ensure you have the [`openai-whisper`](https://pypi.org/project/openai-whisper/) package installed.
23
  For this example, we'll also install 🤗 Datasets to load a toy audio dataset from the Hugging Face Hub:
@@ -55,6 +55,27 @@ To transcribe a local audio file, simply pass the path to the audio file as the
55
  pred_out = transcribe(model, audio="audio.mp3")
56
  ```
57
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
58
  ## Model Details
59
 
60
  For more information about the distil-large-v3 model, refer to the original [model card](https://huggingface.co/distil-whisper/distil-large-v3).
 
17
  outperformed distil-large-v2 by 5% WER average. Thus, you can expect significant performance gains by switching to this
18
  latest checkpoint.
19
 
20
+ ## Python Usage
21
 
22
  To use the model in the original Whisper format, first ensure you have the [`openai-whisper`](https://pypi.org/project/openai-whisper/) package installed.
23
  For this example, we'll also install 🤗 Datasets to load a toy audio dataset from the Hugging Face Hub:
 
55
  pred_out = transcribe(model, audio="audio.mp3")
56
  ```
57
 
58
+ ## CLI Usage
59
+
60
+ The Distil-Whisper model can also be used with the OpenAI Whisper CLI. First, pip install the Hugging Face Hub package:
61
+
62
+ ```bash
63
+ pip install --upgrade huggingface_hub
64
+ ```
65
+
66
+ Next, download the weights for distil-large-v3 locally:
67
+
68
+ ```bash
69
+ huggingface-cli download distil-whisper/distil-large-v3-openai model.bin --local-dir distil-large-v3
70
+ ```
71
+
72
+ Finally, use the OpenAI Whisper CLI to transcribe:
73
+
74
+ ```bash
75
+ whisper audio.mp3 --model distil-large-v3/model.bin
76
+ ```
77
+
78
+
79
  ## Model Details
80
 
81
  For more information about the distil-large-v3 model, refer to the original [model card](https://huggingface.co/distil-whisper/distil-large-v3).