lightmare/whispercpp.py
1
1
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarified documentation

Browse Source
This commit is contained in:
lightmare 2023-03-02 18:13:32 +00:00
parent d14f1b6c25
commit d6c4748424
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
whispercpp.pyx
View File

@ -156,7 +156,7 @@ cdef class Whisper:
filename: Path to file
Returns:
A result id for extract_text(...)
Return value of whisper_full for extract_text(...)
Raises:
RuntimeError: The given file could not be found
@ -172,13 +172,13 @@ cdef class Whisper:
"""Extracts the text from a transcription.
Args:
res: A result id from transcribe(...)
res: A return value from transcribe(...)
Returns:
A list of transcribed strings.
Raises:
RuntimeError: The given result id was invalid.
RuntimeError: The given return value was invalid.
"""
#print("Extracting text...")
if res != 0:
@ -192,14 +192,14 @@ cdef class Whisper:
"""Extracts the text and timestamps from a transcription.
Args:
res: A result id from transcribe(...)
res: A return value from transcribe(...)
Returns:
A list of tuples containing start time, end time and transcribed text.
e.g. [(0, 500, " This is a test.")]
Raises:
RuntimeError: The given result id was invalid.
RuntimeError: The given return value was invalid.
"""
if res != 0:
raise RuntimeError