You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# 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**.
3
3
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.
4
4
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)**
6
6
# Table Of Content
7
7
8
8
-[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
14
14
-[Trainer](#trainer)
15
15
-[Data Loader](#data-loader)
16
16
-[Logger](#logger)
17
-
-[Configration](#configration)
17
+
-[Configration](#configuration)
18
18
-[Main](#main)
19
19
-[Future Works](#future-works)
20
20
-[Contributing](#Contributing)
21
21
22
22
# 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:
24
24
- In models folder create a class named VGG that inherit the "base_model" class
25
25
26
26
```python
@@ -90,7 +90,7 @@ In a nutshell here's how to use this templete, so **for example** assume you wan
90
90
trainer.train()
91
91
92
92
```
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.**
94
94
95
95
96
96
# In Details
@@ -125,7 +125,7 @@ Folder structure
125
125
│
126
126
│
127
127
├── 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.
129
129
│
130
130
└── utils
131
131
├── logger.py
@@ -164,11 +164,11 @@ Folder structure
164
164
1. Create your trainer class and Inherit the base_trainer class.
165
165
2. override these two functions "train_step", "train_epoch" where you implement the training process of each step and each epoch.
166
166
### 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.
168
168
### 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().
170
170
### 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.
0 commit comments