From 581cf50654373d2fd181df928472d6c9e2413419 Mon Sep 17 00:00:00 2001
From: owos <owodunniabraham@gmail.com>
Date: Mon, 4 Mar 2024 16:33:45 +0000
Subject: [PATCH] update readme with how to run code

---
 recipes/ljspeech/xtts_v2/README.md | 53 ++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 recipes/ljspeech/xtts_v2/README.md

diff --git a/recipes/ljspeech/xtts_v2/README.md b/recipes/ljspeech/xtts_v2/README.md
new file mode 100644
index 00000000..d4f9af0c
--- /dev/null
+++ b/recipes/ljspeech/xtts_v2/README.md
@@ -0,0 +1,53 @@
+
+# Coqui AI TTS
+
+This repository contains the code for training a text-to-speech (TTS) model using Coqui AI's TTS framework.
+
+## Installation and Configuration
+
+1. **Clone the repository:**
+
+   ```bash
+   git clone https://github.com/owos/coqui-ai-TTS.git
+   ```
+
+2. **Navigate to the repository root:**
+
+   ```bash
+   cd coqui-ai-TTS
+   ```
+
+3. **Install system dependencies and the code:**
+
+   ```bash
+   make system-deps  # Intended to be used on Ubuntu (Debian). Let us know if you have a different OS.
+   make install
+   ```
+
+4. **Open the following file and redefine the specified variables:**
+
+   File: `recipes/ljspeech/xtts_v2/train_gpt_xtts.py`
+
+   ```python
+   # Line 30
+   path = 'the root path to the audio dirs on your machine'
+
+   # Line 31
+   meta_file_train = "the root path to the train CSV on your machine"
+
+   # Line 32
+   meta_file_val = "the root path to the train CSV on your machine"
+
+   # Line 75
+   SPEAKER_REFERENCE = "a list with a single path to a test audio from the afro tts data"
+   ```
+
+## Running the Code
+
+From the repository root, run the following command:
+
+```bash python
+python3 recipes/ljspeech/xtts_v2/train_gpt_xtts.py
+```
+
+You are now ready to train your TTS model using Coqui AI's framework. Enjoy!
\ No newline at end of file