updated readme

README.md

@@ -4,13 +4,22 @@ Supported Languages: Assamese, Bengali, Bodo, Gujarati, Hindi, Kannada, Malayala
 ---
 
 # Fastspeech2_HS_Flask_API
-Flask API implementation of the Text to Speech Model developed my Speech Lab, IIT Madras.
 
-Please refer the original repository for more details of models and inference.
+This repository contains the Flask API implementation of the Text to Speech Model developed by the Speech Lab at IIT Madras. 
+For a comprehensive understanding of the models and inference details, please consult the original repository 
+[Fastspeech2_HS](https://github.com/smtiitm/Fastspeech2_HS).
 
-The Repo is large in size, some of the alrge files are uploaded using gut lfs
+### Table of Contents
+- [Setup](#setup)
+- [Installation](#installation)
+- [Run Flask server](#run-flask-server)
+- [Citation for the original repo](#citation-for-the-original-repo)
 
-please install latest git LFS from the link, before proceeding to download large model files.
+### Setup
+Some of the large files in this repo are uploaded using git lfs. Install latest git LFS by following the given commands:
+
+Some of the large files in this repository have been uploaded using Git-LFS. 
+To ensure seamless handling of these files, please install Git-LFS by executing the provided commands:
 
 ```
 curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.python.sh | bash
@@ -18,88 +27,60 @@ sudo apt-get install git-lfs
 git lfs install
 ```
 
-The complete repository along with the models are uploaded into hugginface.
+The entire repository, including the models, has been uploaded to Hugging Face 
+"[Fastspeech2_HS_Flask_API](https://huggingface.co/k-m-irfan/Fastspeech2_HS_Flask_API)" due to size restrictions on GitHub for Git LFS. 
+To clone the repository from Hugging Face, please use the following command:
 
-Clone the huggingface repo below
 ```
 git clone https://huggingface.co/k-m-irfan/Fastspeech2_HS_Flask_API
 ```
-Or download the models form original repository [add link] and arrange the folder structure in the given format:
+
+Alternatively, you can download the models from the original repository [Fastspeech2_HS](https://github.com/smtiitm/Fastspeech2_HS) 
+and organize the folder structure as specified below. Skip this step if already cloned the repository from Hugging Face.
 
 ```
 models
-├── assamese
-│   ├── female
-│   └── male
-├── bengali
-│   ├── female
-│   └── male
-├── bodo
-│   └── female
-├── english
-│   ├── female
-│   └── male
-├── gujarati
-│   ├── female
-│   └── male
 ├── hindi
 │   ├── female
 │   └── male
-├── kannada
-│   ├── female
-│   └── male
-├── malayalam
-│   ├── female
-│   └── male
-├── manipuri
-│   ├── female
-│   └── male
-├── marathi
-│   ├── female
-│   └── male
-├── odia
-│   ├── female
-│   └── male
-├── punjabi
-│   ├── female
-│   └── male
-├── rajasthani
-│   ├── female
-│   └── male
 ├── tamil
 │   ├── female
 │   └── male
-├── telugu
-│   ├── female
-│   └── male
-└── urdu
+.
+.
+.
+└── marathi
     ├── female
     └── male
 ```
 
-Installation:
+### Installation:
 
-create a virtual environment, and activate it:
+Create a virtual environment and activate it:
 ```
 python3 -m venv tts-hs-hifigan
 source tts-hs-hifigan/bin/activate
 ```
-install requirements:
+
+Install the required dependencies by running:
 ```
 pip install -r requirements.txt
 ```
-check if the app is running correctly, or look for any errors using commands below:
+
+### Run Flask server:
+Ensure the server application is running correctly before proceeding. Use the following commands and check for any errors:
 ```
 python3 flask_app.py
 # OR
 gunicorn -w 2 -b 0.0.0.0:5000 flask_app:app --timeout 600
 ```
-If it's running without any problem. run the start command to start the server.
+
+If the application is running without any issues, proceed to start the server using the following command:
 ```
 bash start.sh
 ```
 
-### Citation
+### Citation for the original repo
 If you use this Fastspeech2 Model in your research or work, please consider citing:
 
 “