# hand_detection

**Repository Path**: jeffreyyan24/hand_detection

## Basic Information

- **Project Name**: hand_detection
- **Description**: A Light CNN based Method for Hand Detection and Orientation Estimation
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-03-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Hand Detection and Orientation Estimation
This project utilizes a modified MobileNet in company with the [SSD](https://github.com/weiliu89/caffe/tree/ssd) framework to achieve a robust and fast detection of hand location and orientation. 
Our implementation is adapted from [the PyTorch version of SSD](https://github.com/amdegroot/ssd.pytorch) and [MobileNet](https://github.com/ruotianluo/pytorch-mobilenet-from-tf).

<img src="https://github.com/yangli18/hand_detection/blob/master/data/results/demo/010174_hand.svg" height=226><img src="https://github.com/yangli18/hand_detection/blob/master/data/results/demo/010061_hand.svg" height=226><img src="https://github.com/yangli18/hand_detection/blob/master/data/results/demo/010210_hand.svg" height=226>

### Contents
1. [Preparation](#preparation)
2. [Training](#training)
3. [Evaluation](#Evaluation)


### Preparation
1. Due to some compatibility issues, we recommend to install PyTorch 0.3.0 and Python 3.6.8, which our project currently supports. 

2. Get the code. 
    ```Shell
    git clone https://github.com/yangli18/hand_detection.git
    ```
3. Download [the Oxford hand dataset](http://www.robots.ox.ac.uk/~vgg/data/hands/) and create the LMDB file for the training data.
    ```Shell
    sh data/scripts/Oxford_hand_dataset.sh
    ```
4. Compile the NMS code (from [ruotianluo/pytorch-faster-rcnn](https://github.com/ruotianluo/pytorch-faster-rcnn/tree/0.3)).
    ```Shell
    sh layers/src/make.sh
    ```


### Training

Train the detection model on the Oxford hand dataset. 
```Shell
python train.py 2>&1 | tee log/train.log
```
* Trained with data augmentation v2, our detection model reaches over **86%** average precision (AP) on the Oxford hand dataset. We provide the trained model in the `weights` dir.
* For the convenience of training, a pre-trained MobileNet is put in the `weights` dir. 
You can also download it from [here](https://github.com/ruotianluo/pytorch-mobilenet-from-tf).
 

### Evaluation

1. Evaluate the trained detection model.
    ```Shell
    python eval.py --trained_model weights/ssd_new_mobilenet_FFA.pth --version ssd_new_mobilenet_FFA
    ```
    * ***Note***: For a fair comparison, the evaluation code of the Oxford hand dataset should be used to get the exact mAP (mean Average Precision) of hand detection. 
    The above command should return a similar result, but not exactly the same.
    
2. Evaluate the average detection time.
    ```Shell
    python eval_speed.py --trained_model weights/ssd_new_mobilenet_FFA.pth --version ssd_new_mobilenet_FFA
    ```