Skip to content

Commit 1c7924f

Browse files
committed
docs: move project structure from readme into documentation
1 parent febc889 commit 1c7924f

File tree

3 files changed

+31
-20
lines changed

3 files changed

+31
-20
lines changed

README.md

-20
Original file line numberDiff line numberDiff line change
@@ -391,23 +391,3 @@ $ tts --out_path output/path/speech.wav --model_name "<language>/<dataset>/<mode
391391
```
392392
393393
<!-- end-tts-readme -->
394-
395-
## Directory Structure
396-
```
397-
|- notebooks/ (Jupyter Notebooks for model evaluation, parameter selection and data analysis.)
398-
|- utils/ (common utilities.)
399-
|- TTS
400-
|- bin/ (folder for all the executables.)
401-
|- train*.py (train your target model.)
402-
|- ...
403-
|- tts/ (text to speech models)
404-
|- layers/ (model layer definitions)
405-
|- models/ (model definitions)
406-
|- utils/ (model specific utilities.)
407-
|- speaker_encoder/ (Speaker Encoder models.)
408-
|- (same)
409-
|- vocoder/ (Vocoder models.)
410-
|- (same)
411-
|- vc/ (Voice conversion models.)
412-
|- (same)
413-
```

docs/source/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ tutorial_for_nervous_beginners
1313
installation
1414
docker_images
1515
faq
16+
project_structure
1617
contributing
1718
```
1819

docs/source/project_structure.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Project structure
2+
3+
## Directory structure
4+
5+
A non-comprehensive overview of the Coqui source code:
6+
7+
| Directory | Contents |
8+
| - | - |
9+
| **Core** | |
10+
| **[`TTS/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS)** | Main source code |
11+
| **[`- .models.json`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/.models.json)** | Pretrained model list |
12+
| **[`- api.py`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/api.py)** | Python API |
13+
| **[`- bin/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/bin)** | Executables and CLI |
14+
| **[`- tts/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/tts)** | Text-to-speech models |
15+
| **[`- configs/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/tts/configs)** | Model configurations |
16+
| **[`- layers/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/tts/layers)** | Model layer definitions |
17+
| **[`- models/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/tts/models)** | Model definitions |
18+
| **[`- vc/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/vc)** | Voice conversion models |
19+
| `- (same)` | |
20+
| **[`- vocoder/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/vocoder)** | Vocoder models |
21+
| `- (same)` | |
22+
| **[`- encoder/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/TTS/encoder)** | Speaker encoder models |
23+
| `- (same)` | |
24+
| **Recipes/notebooks** | |
25+
| **[`notebooks/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/notebooks)** | Jupyter Notebooks for model evaluation, parameter selection and data analysis |
26+
| **[`recipes/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/recipes)** | Training recipes |
27+
| **Others** | |
28+
| **[`pyproject.toml`](https://github.com/idiap/coqui-ai-TTS/tree/dev/pyproject.toml)** | Project metadata, configuration and dependencies |
29+
| **[`docs/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/docs)** | Documentation |
30+
| **[`tests/`](https://github.com/idiap/coqui-ai-TTS/tree/dev/tests)** | Unit and integration tests |

0 commit comments

Comments
 (0)