From f37918d9d2cc4f0f430f81c46f21d5ba3dd4427c Mon Sep 17 00:00:00 2001
From: Shivam Mehta <shivam.mehta25@gmail.com>
Date: Sat, 16 Sep 2023 19:27:46 +0000
Subject: [PATCH] Updating readme and setup with information

---
 README.md | 16 ++++++++++++++++
 setup.py  | 15 ++++++++++++---
 2 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 4caa5f7..0c8819c 100644
--- a/README.md
+++ b/README.md
@@ -140,6 +140,22 @@ train_filelist_path: data/filelists/ljs_audio_text_train_filelist.txt
 valid_filelist_path: data/filelists/ljs_audio_text_val_filelist.txt
 ```
 
+5. Generate normalisation statistics with the yaml file of dataset configuration
+
+```bash
+matcha-data-stats -i ljspeech.yaml
+# Output:
+#{'mel_mean': -5.53662231756592, 'mel_std': 2.1161014277038574}
+```
+
+Update these values in `configs/data/ljspeech.yaml` under `data_statistics` key.
+
+```bash
+data_statistics:  # Computed for ljspeech dataset
+  mel_mean: -5.536622
+  mel_std: 2.116101
+```
+
 to the paths of your train and validation filelists.
 
 5. Run the training script
diff --git a/setup.py b/setup.py
index 516d410..a163ad2 100644
--- a/setup.py
+++ b/setup.py
@@ -12,10 +12,16 @@ exts = [
     )
 ]
 
+with open("README.md", "r", encoding="utf-8") as readme_file:
+    README = readme_file.read()
+
+
 setup(
-    name="matcha",
+    name="matcha_tts",
     version="0.1.0",
-    description="A fast TTS architecture with conditional flow matching",
+    description="🍵 Matcha-TTS: A fast TTS architecture with conditional flow matching",
+    long_description=README,
+    long_description_content_type="text/markdown",
     author="Shivam Mehta",
     author_email="shivam.mehta25@gmail.com",
     url="https://shivammehta25.github.io/Matcha-TTS",
@@ -24,14 +30,17 @@ setup(
         for r in open(os.path.join(os.path.dirname(__file__), "requirements.txt"))
     ],
     include_dirs=[numpy.get_include()],
+    include_package_data=True,
     packages=find_packages(exclude=["tests", "tests/*", "examples", "examples/*"]),
     # use this to customize global commands available in the terminal after installing the package
     entry_points={
         "console_scripts": [
             "matcha-data-stats=matcha.utils.generate_data_statistics:main",
             "matcha_tts=matcha.cli:cli",
-            "matcha_tts_app=matcha.app:main",
+            "matcha_tts-app=matcha.app:main",
         ]
     },
     ext_modules=cythonize(exts, language_level=3),
+    python_requires=">=3.10.0",
+
 )