DEEP Open Catalogue: Image classification
Author: Ignacio Heredia (CSIC)
Project: This work is part of the DEEP Hybrid-DataCloud project that has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 777435.
This is a plug-and-play tool to train and evaluate an image classifier on a custom dataset using deep neural networks.
To start using this framework run:
git clone https://github.com/deephdc/image-classification-tf cd image-classification-tf pip install -e .
- This project has been tested in Ubuntu 18.04 with Python 3.6.5. Further package requirements are described in the
- It is a requirement to have Tensorflow>=1.12.0 installed (either in gpu or cpu mode). This is not listed in the
requirements.txtas it breaks GPU support.
python -c 'import cv2'to check that you installed correctly the
opencv-pythonpackage (sometimes dependencies are missed in
├── LICENSE ├── README.md <- The top-level README for developers using this project. ├── data │ ├── images <- The original, immutable data dump. │ │ │ └── data_splits <- Scripts to download or generate data │ ├── docs <- A default Sphinx project; see sphinx-doc.org for details │ ├── docker <- Directory for Dockerfile(s) │ ├── models <- Trained and serialized models, model predictions, or model summaries │ ├── notebooks <- Jupyter notebooks. │ ├── references <- Data dictionaries, manuals, and all other explanatory materials. │ ├── reports <- Generated analysis as HTML, PDF, LaTeX, etc. │ └── figures <- Generated graphics and figures to be used in reporting │ ├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g. │ generated with `pip freeze > requirements.txt` ├── test-requirements.txt <- The requirements file for the test environment │ ├── setup.py <- makes project pip installable (pip install -e .) so imgclas can be imported ├── imgclas <- Source code for use in this project. │ ├── __init__.py <- Makes imgclas a Python module │ │ │ ├── dataset <- Scripts to download or generate data │ │ └── make_dataset.py │ │ │ ├── features <- Scripts to turn raw data into features for modeling │ │ └── build_features.py │ │ │ ├── models <- Scripts to train models and then use trained models to make │ │ │ predictions │ │ └── model.py │ │ │ └── tests <- Scripts to perfrom code testing + pylint script │ │ │ └── visualization <- Scripts to create exploratory and results oriented visualizations │ └── visualize.py │ └── tox.ini <- tox file with settings for running tox; see tox.testrun.org
Project based on the cookiecutter data science project template. #cookiecutterdatascience
1. Data preprocessing
The first step to train yout image classifier if to have the data correctly set up.
1.1 Prepare the images
Put your images in the
./data/images folder. If you have your data somewhere else you can use that location by setting the
image_dir parameter in the
Please use a standard image format (like
1.2 Prepare the data splits
First you need add to the
./data/dataset_files directory the following files:
|Mandatory files||Optional files|
test.txt files associate an image name (or relative path) to a label number (that has to start at zero).
classes.txt file translates those label numbers to label names.
info.txt allows you to provide information (like number of images in the database) about each class. This information will be shown when launching a webpage of the classifier.
You can find examples of these files at
2. Train the classifier
Before training the classifier you can customize the default parameters of the configuration file. To have an idea of what parameters you can change, you can explore them using the dataset exploration notebook. This step is optional and training can be launched with the default configurarion parameters and still offer reasonably good results.
Once you have customized the configuration parameters in the
./etc/config.yaml file you can launch the training running
./imgclas/train_runfile.py. You can monitor the training status using Tensorboard.
After training check the training notebook to see how to visualize the training statistics.
3. Test the classifier
You can test the classifier on a number of tasks: predict a single local image (or url), predict multiple images (or urls), merge the predictions of a multi-image single observation, etc. All these tasks are explained in the computing predictions notebook.
You can also make and store the predictions of the
test.txt file (if you provided one). Once you have done that you can visualize the statistics of the predictions like popular metrics (accuracy, recall, precision, f1-score), the confusion matrix, etc by running the predictions statistics notebook.
By running the saliency maps notebook you can also visualize the saliency maps of the predicted images, which show what were the most relevant pixels in order to make the prediction.
Finally you can launch a simple webpage to use the trained classifier to predict images (both local and urls) on your favorite brownser.
Launching the full API
Preliminaries for prediction
If you want to use the API for prediction, you have to do some preliminary steps to select the model you want to predict with:
- copy your desired
.models/api. If there is no
.models/apifolder, the default is to use the last available timestamp.
- in the
.models/api/ckptsleave only the desired checkpoint to use for prediction. If there are more than one chekpoints, the default is to use the last available checkpoint.
Running the API
To access this package's complete functionality (both for training and predicting) through an API you have to install the DEEPaaS package:
git clone https://github.com/indigo-dc/deepaas cd deepaas pip install -e .
deepaas-run --listen-ip 0.0.0.0.
From there you will be able to run training and predictions of this package using