Skip to content

Commit

Permalink
add folder structure in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dai gang committed Apr 12, 2023
1 parent cd24145 commit 8ffdffc
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,41 @@
![python 3.8](https://img.shields.io/badge/python-3.8-brightgreen)
# Disentangling Writer and Character Styles for Handwriting Generation
Detailed documentation is coming.

## Folder Structure
```
SDT/
├── train.py - main script to start training
├── test.py - generate characters via trained model
├── evaluate.py - evaluation of generated samples
├── configs/*.yml - holds configuration for training
├── parse_config.py - class to handle config file
├── data_loader/ - anything about data loading goes here
│ └── loader.py
├── model_zoo/ - pre-trained model
├── data/ - default directory for storing experimental datasets
├── model/ - networks, models and losses
│ ├── encoder.py
│ ├── gmm.py
│ ├── loss.py
│ ├── model.py
│ └── transformer.py
├── saved/
│ ├── models/ - trained models are saved here
│ ├── tborad/ - tensorboard visualization
│ └── samples/ - visualization samples in the training process
├── trainer/ - trainers
│ └── trainer.py
└── utils/ - small utility functions
├── util.py
└── logger.py - set log dir for tensorboard and logging output
```

0 comments on commit 8ffdffc

Please sign in to comment.