Yurii Paniv commited on
Commit
bbc2ff2
1 Parent(s): 17873e4

Add how to contribute

Browse files
Files changed (1) hide show
  1. README.md +23 -0
README.md CHANGED
@@ -65,8 +65,31 @@ https://user-images.githubusercontent.com/5759207/224504363-0227e8bf-8c1c-49ad-8
65
 
66
  # How to use: 📢
67
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
68
  See example notebook: [tts_example.ipynb](./tts_example.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/robinhad/ukrainian-tts/blob/main/tts_example.ipynb)
69
 
 
 
 
 
70
  # How to train: 🏋️
71
  Link to guide: [training/STEPS.md](training/STEPS.md)
72
 
65
 
66
  # How to use: 📢
67
 
68
+ ## Quickstart
69
+
70
+ Install using:
71
+ ```bash
72
+ !pip install git+https://github.com/robinhad/ukrainian-tts.git
73
+ ```
74
+ Code example:
75
+ ```python
76
+ from ukrainian_tts.tts import TTS, Voices, Stress
77
+ import IPython.display as ipd
78
+
79
+ tts = TTS(device="cpu") # can try gpu, mps
80
+ with open("test.wav", mode="wb") as file:
81
+ _, output_text = tts.tts("Привіт, як у тебе справи?", Voices.Dmytro.value, Stress.Dictionary.value, file)
82
+ print("Accented text:", output_text)
83
+
84
+ ipd.Audio(filename="test.wav")
85
+ ```
86
+
87
  See example notebook: [tts_example.ipynb](./tts_example.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/robinhad/ukrainian-tts/blob/main/tts_example.ipynb)
88
 
89
+ # How to contribute: 🙌
90
+
91
+ Look into this list with current problems: https://github.com/robinhad/ukrainian-tts/issues/35
92
+
93
  # How to train: 🏋️
94
  Link to guide: [training/STEPS.md](training/STEPS.md)
95