Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sglvladi committed Jul 26, 2020
1 parent 7be674f commit ce60a05
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,16 @@

This is a "short" (rather lengthy) tutorial that started off as self notes on how to set-up and get going with the TensorFlow Object Detection API.

To read the actual tutorial, you have the following 2 (more like 3) options:
1. Visit [http://tensorflow-object-detection-api-tutorial.readthedocs.io](http://tensorflow-object-detection-api-tutorial.readthedocs.io). (By far the easiest)
2. Clone/Download the repo:
- Open the "index.html" files under docs/build/ (Not guaranteed to be up-to-date)
- Build the docs using Sphinx and the open "index.html" (Guaranteed to be up-to-date)
There currently exist several versions of the tutorial, corresponding to the various different versions of TensorFlow. The two major versions are outlined below.

## TensorFlow 2 Object Detection API tutorial [![Documentation Status](https://readthedocs.org/projects/tensorflow-object-detection-api-tutorial/badge/?version=latest)](http://tensorflow-object-detection-api-tutorial.readthedocs.io/en/latest/?badge=latest)

Since July 10, 2020 TensorFlow [announced that the Object Detection API officially supports TensorFlow 2](https://blog.tensorflow.org/2020/07/tensorflow-2-meets-object-detection-api.html). Therefore, an updated version of the tutorial was created to cover TensorFlow 2.

To read the tutorial, visit [http://tensorflow-object-detection-api-tutorial.readthedocs.io](http://tensorflow-object-detection-api-tutorial.readthedocs.io).

## TensorFlow Object Detection API tutorial [![Documentation Status](https://readthedocs.org/projects/tensorflow-object-detection-api-tutorial/badge/?version=1.14.2)](http://tensorflow-object-detection-api-tutorial.readthedocs.io/en/1.14.2/?badge=1.14.2)

Originally, the tutorial was written with TensorFlow 1 in mind. Since it is possible that many users will still be interested in working with TensorFlow 1, a version of this tutorial will also be maintained for the foreseeable future.

To read the tutorial, visit [https://tensorflow-object-detection-api-tutorial.readthedocs.io/en/1.14.2/](https://tensorflow-object-detection-api-tutorial.readthedocs.io/en/1.14.2/).

0 comments on commit ce60a05

Please sign in to comment.