agladyshev/breed-classifier

This is a study project for Udacity Deep Learning Nanondegree

Breed Classifier project

This is a study project from Udacity Deep Learning Nanodegree. In this project, I have built a pipeline that can be used within a web or mobile app to process real-world, user-supplied images. Given an image of a dog, this algorithm will identify an estimate of the canine’s breed. If supplied an image of a human, the code will identify the resembling dog breed. I've also built a [telegram bot]https://github.com/agladyshev/dog_breed_bot) which utilizes this algorytihm and provide more fun and clean user experience.

Project Instructions

To check out complete notebook

1. Clone the repository and navigate to the downloaded folder.

git clone https://github.com/agladyshev/dog-project.git
cd dog-project

2. Open the notebook.

jupyter notebook dog_app.ipynb

To run the notebook yourself

1. Download the dog dataset. Unzip the folder and place it in the repo, at location path/to/dog-project/dogImages.

2. Download the human dataset. Unzip the folder and place it in the repo, at location path/to/dog-project/lfw. If you are using a Windows machine, you are encouraged to use 7zip to extract the folder.

3. Donwload the VGG-16 bottleneck features for the dog dataset. Place it in the repo, at location path/to/dog-project/bottleneck_features.

4. (Optional) If you plan to install TensorFlow with GPU support on your local machine, follow the guide to install the necessary NVIDIA software on your system. If you are using an EC2 GPU instance, you can skip this step.

5. (Optional) If you are running the project on your local machine (and not using AWS), create (and activate) a new environment.

   • Linux (to install with GPU support, change requirements/dog-linux.yml to requirements/dog-linux-gpu.yml):

   conda env create -f requirements/dog-linux.yml
   source activate dog-project
   

   • Mac (to install with GPU support, change requirements/dog-mac.yml to requirements/dog-mac-gpu.yml):

   conda env create -f requirements/dog-mac.yml
   source activate dog-project
   

   NOTE: Some Mac users may need to install a different version of OpenCV

   conda install --channel https://conda.anaconda.org/menpo opencv3
   

   • Windows (to install with GPU support, change requirements/dog-windows.yml to requirements/dog-windows-gpu.yml):

   conda env create -f requirements/dog-windows.yml
   activate dog-project
   

6. (Optional) If you are running the project on your local machine (and not using AWS) and Step 6 throws errors, try this alternative step to create your environment.

   • Linux or Mac (to install with GPU support, change requirements/requirements.txt to requirements/requirements-gpu.txt):

   conda create --name dog-project python=3.5
   source activate dog-project
   pip install -r requirements/requirements.txt
   

   NOTE: Some Mac users may need to install a different version of OpenCV

   conda install --channel https://conda.anaconda.org/menpo opencv3
   

   • Windows (to install with GPU support, change requirements/requirements.txt to requirements/requirements-gpu.txt):

   conda create --name dog-project python=3.5
   activate dog-project
   pip install -r requirements/requirements.txt
   

7. (Optional) If you are using AWS, install Tensorflow.

sudo python3 -m pip install -r requirements/requirements-gpu.txt

8. Switch Keras backend to TensorFlow.

   • Linux or Mac:

      KERAS_BACKEND=tensorflow python -c "from keras import backend"
     

   • Windows:

      set KERAS_BACKEND=tensorflow
      python -c "from keras import backend"
     

9. (Optional) If you are running the project on your local machine (and not using AWS), create an IPython kernel for the dog-project environment.

python -m ipykernel install --user --name dog-project --display-name "dog-project"

10. (Optional) If you are running the project on your local machine (and not using AWS), before running code, change the kernel to match the dog-project environment by using the drop-down menu (Kernel > Change kernel > dog-project). Then, follow the instructions in the notebook.