Browse Source

Update of documentation

jbuisine 2 years ago
parent
commit
516290d3c5
1 changed files with 9 additions and 10 deletions
  1. 9 10
      README.md

+ 9 - 10
README.md

@@ -8,19 +8,18 @@ pip install -r requirements.txt
 
 ## How to use
 
-Generate dataset (run only once time) :
+Generate dataset (run only once time or clean data folder before) :
 ```
 python generate_dataset.py
 ```
 
 It will split scenes and generate all data you need for your neural network.
-You can specify the number of sub images you want in the script by modifying NUMBER_SUB_IMAGES variables.
+You can specify the number of sub images you want in the script by modifying **_NUMBER_SUB_IMAGES_** variables.
 
-
-There are 3 kind of Neural Networks :
-- classification_cnn_keras.py : based croped on images
-- classification_cnn_keras_crossentropy.py : based croped on images which are randomly split for training
-- classification_cnn_keras_svd.py : based on svd metrics of image
+There are 3 kinds of Neural Networks :
+- **classification_cnn_keras.py** : *based croped on images*
+- **classification_cnn_keras_crossentropy.py** : *based croped on images which are randomly split for training*
+- **classification_cnn_keras_svd.py** : *based on svd metrics of image*
 
 Note that the image input size need to change in you used specific size for your croped images.
 
@@ -32,10 +31,10 @@ python classification_cnn_keras.py
 ## Modules
 
 This project contains modules :
-- modules/image_metrics : where all computed metrics function are developed
-- modules/model_helper : contains helpful function to save or display model information and performance
+- **modules/image_metrics** : *where all computed metrics function are developed*
+- **modules/model_helper** : *contains helpful function to save or display model information and performance*
 
-All these modules will grow during developement of the project
+All these modules will be enhanced during development of the project
 
 ## How to contribute