Skip to content

Commit

Permalink
updated ReadME
Browse files Browse the repository at this point in the history
  • Loading branch information
TannerGilbert committed Nov 8, 2019
1 parent 0e79cc8 commit 86e1746
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Expand Up @@ -3,5 +3,17 @@

Detectron2 is Facebooks new library that implements state-of-the-art object detection algorithm. This repository shows you how to use Detectron2 for both inference as well as using transfer learning to train on your own data-set.

## Installation

See the official [installation guide](https://github.com/facebookresearch/detectron2/blob/master/INSTALL.md).

## Inference with pre-trained model

Using a pre-trained model for inference is as easy as loading in the cofiguration and weights and creating a predictor object. For a example check out [Detectron2_inference_with_pre_trained_model.ipynb](Detectron2_inference_with_pre_trained_model.ipynb).

## Training on a custom dataset

Training a model on a custom dataset is a bit more challenging because it requires that we [register our dataset](https://detectron2.readthedocs.io/tutorials/datasets.html#register-a-dataset). For a example showing you how to train a balloon detection model check out [Detectron2_train_on_a_custom_dataset.ipynb](Detectron2_train_on_a_custom_dataset.ipynb).

## Author
**Gilbert Tanner**

0 comments on commit 86e1746

Please sign in to comment.