[ADD] initial readme file

README.md

@@ -0,0 +1,14 @@
+# nsfw-detection
+A python flask api that given an image will return a score on how much it's suitable for work, detecting nudity, violence and drugs.
+- For detecting nudity I used [nudeNet](https://github.com/notAI-tech/NudeNet) from notAI
+- For violence and drugs detection, I hypertuned mobilenet on my own collected dataset:
+
+## DataSet for violence and drugs
+- At first I didn't find any avilable dataset online so I collected I set of Imgs by myself:
+  1. **Source of the data:** from google Imgs, duckduckgo Imgs and some from Bing.
+  1. **For batch downloading:** I used [Image Downloader](https://chrome.google.com/webstore/detail/image-downloader/cnpniohnfphhjihaiiggeabnkjhpaldj) chrome extension for downloading a bunch of Imgs at once 
+  1. **Number of collected Imgs:** The Imgs I've collected With about 1000 Imgs for each class.
+  1. **As a third class (Natural):** I used a set of natural Imgs from this [dataSet](https://www.kaggle.com/prasunroy/natural-images) in kaggle make sure to look at the Acknowledgements section In kaggle for this dataset. 
+  1. I used Pillow for loading rgb and resizing the Imgs (224, 224) as Imgs size.
+  1. Then I augmented the data using the `ImageDataGenerator` Provided by keras.
+- For more Detailed Info look at the [data-augmentation](./data_preprocessing/data-augmentation.ipynb) notebook.