henryNdubuaku commited on
Commit
32c2de9
·
verified ·
1 Parent(s): d933428

Card: needle.transcribe is the entry point

Browse files
Files changed (1) hide show
  1. README.md +2 -3
README.md CHANGED
@@ -62,12 +62,11 @@ The Python package and the source are on [GitHub](https://github.com/cactus-comp
62
  ```python
63
  import needle
64
 
65
- whistle = needle.Whistle()
66
- print(whistle.transcribe("clip.wav")["text"])
67
  # turn off the kitchen lights
68
  ```
69
 
70
- Every call returns the text, the language, the milliseconds to the first token and the decoder's tokens per second after it. `word_timestamps=True` adds each word with its start, end and probability, `keywords=[...]` favours the names your users say, and `language="de"` forces the language instead of detecting it. The engine and the weights are fetched once and cached. `needle whistle playground` transcribes from the microphone, and `needle whistle compare` puts Whistle next to Whisper and Moonshine on the same clip.
71
 
72
  ## With Needle
73
 
 
62
  ```python
63
  import needle
64
 
65
+ print(needle.transcribe("clip.wav")["text"])
 
66
  # turn off the kitchen lights
67
  ```
68
 
69
+ Every call returns the text, the language, the milliseconds to the first token and the decoder's tokens per second after it. `word_timestamps=True` adds each word with its start, end and probability, `keywords=[...]` favours the names your users say, and `language="de"` forces the language instead of detecting it. The engine and the weights are fetched once and cached. `needle.Whistle()` is the same model as an object, for `embed(audio)` or to hold one tuned `.cact`. `needle whistle playground` transcribes from the microphone, and `needle whistle compare` puts Whistle next to Whisper and Moonshine on the same clip.
70
 
71
  ## With Needle
72