From de7ed4176c190d54fc3d68ec4624e8664fdd55f3 Mon Sep 17 00:00:00 2001 From: erogol Date: Fri, 19 Jun 2020 15:56:02 +0200 Subject: [PATCH] README directory structure --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 57a979d7..df143174 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,22 @@ Or you can use ```requirements.txt``` to install the requirements only. ```pip install -r requirements.txt``` +### Directory Structure +``` +|- TTS/ +| |- train.py (train your TTS model.) +| |- distribute.py (train your TTS model using Multiple GPUs) +| |- config.json (TTS model configuration file) +| |- tf (Tensorflow 2 utilities and model implementations) +| |- layers/ (model layer definitions) +| |- models/ (model definitions) +| |- notebooks/ (Jupyter Notebooks for model evaluation and parameter selection) +| |- data_analysis/ (TTS Dataset analysis tools and notebooks.) +| |- utils/ (TTS utilities -io, visualization, data processing etc.-) +| |- speaker_encoder/ (Speaker Encoder implementation with the same folder structure.) +| |- vocoder/ (Vocoder implementations with the same folder structure.) +``` + ### Docker A barebone `Dockerfile` exists at the root of the project, which should let you quickly setup the environment. By default, it will start the server and let you query it. Make sure to use `nvidia-docker` to use your GPUs. Make sure you follow the instructions in the [`server README`](server/README.md) before you build your image so that the server can find the model within the image.