From 20e5dd367843aa38a73212ad5da455e67ee4ad19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eren=20G=C3=B6lge?= Date: Fri, 19 Nov 2021 10:35:38 +0100 Subject: [PATCH] Add doc examples --- TTS/tts/utils/text/phonemizers/espeak_wrapper.py | 12 ++++++++++-- TTS/tts/utils/text/phonemizers/gruut_wrapper.py | 7 +++++++ 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/TTS/tts/utils/text/phonemizers/espeak_wrapper.py b/TTS/tts/utils/text/phonemizers/espeak_wrapper.py index 59c4a8ee..45169c17 100644 --- a/TTS/tts/utils/text/phonemizers/espeak_wrapper.py +++ b/TTS/tts/utils/text/phonemizers/espeak_wrapper.py @@ -66,6 +66,14 @@ class ESpeak(BasePhonemizer): keep_puncs (bool): If True, keep the punctuations after phonemization. Defaults to True. + + Example: + + >>> from TTS.tts.utils.text.phonemizers import ESpeak + >>> phonemizer = ESpeak("tr") + >>> phonemizer.phonemize("Bu Türkçe, bir örnektir.", separator="|") + 'b|ʊ t|ˈø|r|k|tʃ|ɛ, b|ɪ|r œ|r|n|ˈɛ|c|t|ɪ|r.' + """ _ESPEAK_LIB = _DEF_ESPEAK_LIB @@ -140,14 +148,14 @@ class ESpeak(BasePhonemizer): count += 1 return langs - def version(self): + def version(self) -> str: """Get the version of the used backend. Returns: str: Version of the used backend. """ args = ["--version"] - for line in self._espeak_exe(args, sync=True): + for line in _espeak_exe(_DEF_ESPEAK_LIB, args, sync=True): version = line.decode("utf8").strip().split()[2] logging.debug("line: %s" % repr(line)) return version diff --git a/TTS/tts/utils/text/phonemizers/gruut_wrapper.py b/TTS/tts/utils/text/phonemizers/gruut_wrapper.py index a1ad1b80..d0aa469e 100644 --- a/TTS/tts/utils/text/phonemizers/gruut_wrapper.py +++ b/TTS/tts/utils/text/phonemizers/gruut_wrapper.py @@ -30,6 +30,13 @@ class Gruut(BasePhonemizer): keep_stress (bool): If true, keep the stress characters after phonemization. Defaults to False. + + Example: + + >>> from TTS.tts.utils.text.phonemizers.gruut_wrapper import Gruut + >>> phonemizer = Gruut('en-us') + >>> phonemizer.phonemize("Be a voice, not an! echo?", separator="|") + 'b|i| ə| v|ɔ|ɪ|s, n|ɑ|t| ə|n! ɛ|k|o|ʊ?' """ def __init__(