update docstring 2

coqui-ai · Apr 6, 2021 · f46a275 · f46a275
1 parent ec94ff3
commit f46a275
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/TTS/utils/synthesizer.py b/TTS/utils/synthesizer.py
@@ -17,9 +17,14 @@
 
 class Synthesizer(object):
  def __init__(self, tts_checkpoint, tts_config, vocoder_checkpoint=None, vocoder_config=None, use_cuda=False):
- """General TTS interface for inference. It takes a tts and a vocoder
- model and synthesize speech from the provided text with a basic text
- formatting.
+ """General 🐸 TTS interface for inference. It takes a tts and a vocoder
+ model and synthesize speech from the provided text.
+
+ The text is divided into a list of sentences using `pysbd` and synthesize 
+ speech on each sentence separately.
+
+ If you have certain special characters in your text, you need to handle
+ them before providing the text to Synthesizer.
 
  TODO: handle multi-speaker and GST inference.