Skip to content

Commit 32aa263

Browse files
committed
readme
1 parent 9ee2c39 commit 32aa263

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Tensorflow Project Template
2-
A simple and well designed structure is essential for any Deep Learning project, so after a lot of practice and contributing in tensorflow projects here's a tensorflow project templete that combines **simplcity**, **best practice for folder structure** and **good OOP design**.
2+
A simple and well designed structure is essential for any Deep Learning project, so after a lot of practice and contributing in tensorflow projects here's a tensorflow project template that combines **simplcity**, **best practice for folder structure** and **good OOP design**.
33
The main idea is that there's much stuff you do every time you start your tensorflow project so wrapping all this shared stuff will help you to change just the core idea everytime you start a new tensorflow project.
44

5-
**So here's a simple tensorflow templete that help you get into your main project faster and just focus on your core (Model, Training, ...etc)**
5+
**So here's a simple tensorflow template that help you get into your main project faster and just focus on your core (Model, Training, ...etc)**
66
# Table Of Content
77

88
- [In a Nutshell](#in-a-nutshell)
@@ -14,13 +14,13 @@ The main idea is that there's much stuff you do every time you start your tensor
1414
- [Trainer](#trainer)
1515
- [Data Loader](#data-loader)
1616
- [Logger](#logger)
17-
- [Configration](#configration)
17+
- [Configration](#configuration)
1818
- [Main](#main)
1919
- [Future Works](#future-works)
2020
- [Contributing](#Contributing)
2121

2222
# In a Nutshell
23-
In a nutshell here's how to use this templete, so **for example** assume you want to implement VGG model so you should do the following:
23+
In a nutshell here's how to use this template, so **for example** assume you want to implement VGG model so you should do the following:
2424
- In models folder create a class named VGG that inherit the "base_model" class
2525

2626
```python
@@ -90,7 +90,7 @@ In a nutshell here's how to use this templete, so **for example** assume you wan
9090
trainer.train()
9191

9292
```
93-
**You will a templete file and a simple example in the model and trainer folder that shows you how to try your first model simply.**
93+
**You will a template file and a simple example in the model and trainer folder that shows you how to try your first model simply.**
9494

9595

9696
# In Details
@@ -125,7 +125,7 @@ Folder structure
125125
126126
127127
├── data _loader
128-
│ └── data_generator.py - here's the data_generator that responsiple for all data handling.
128+
│ └── data_generator.py - here's the data_generator that responsible for all data handling.
129129
130130
└── utils
131131
├── logger.py
@@ -164,11 +164,11 @@ Folder structure
164164
1. Create your trainer class and Inherit the base_trainer class.
165165
2. override these two functions "train_step", "train_epoch" where you implement the training process of each step and each epoch.
166166
### Data Loader
167-
These class is responsiple for all data handling and processing and provide an easy interface that can be used by the trainer.
167+
These class is responsible for all data handling and processing and provide an easy interface that can be used by the trainer.
168168
### Logger
169-
This class is responsiple for the tensorboard summary, in your trainer create a dictionary of all tensorflow variables you want to summarize then pass this dictionary to logger.summarize().
169+
This class is responsible for the tensorboard summary, in your trainer create a dictionary of all tensorflow variables you want to summarize then pass this dictionary to logger.summarize().
170170
### Configration
171-
I use Json as configration method and then parse it, so write all configs you want then parse it using "utils/config/process_config" and pass this configration object to all other objects.
171+
I use Json as configuration method and then parse it, so write all configs you want then parse it using "utils/config/process_config" and pass this configuration object to all other objects.
172172
### Main
173173
Here's where you combine all previous part.
174174
1. Parse the config file.

0 commit comments

Comments
 (0)