Skip to content

Commit ce60a05

Browse files
authored
Update README.md
1 parent 7be674f commit ce60a05

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,16 @@
33

44
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.
55

6-
To read the actual tutorial, you have the following 2 (more like 3) options:
7-
1. Visit [http://tensorflow-object-detection-api-tutorial.readthedocs.io](http://tensorflow-object-detection-api-tutorial.readthedocs.io). (By far the easiest)
8-
2. Clone/Download the repo:
9-
- Open the "index.html" files under docs/build/ (Not guaranteed to be up-to-date)
10-
- Build the docs using Sphinx and the open "index.html" (Guaranteed to be up-to-date)
6+
There currently exist several versions of the tutorial, corresponding to the various different versions of TensorFlow. The two major versions are outlined below.
7+
8+
## 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)
9+
10+
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.
11+
12+
To read the tutorial, visit [http://tensorflow-object-detection-api-tutorial.readthedocs.io](http://tensorflow-object-detection-api-tutorial.readthedocs.io).
13+
14+
## 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)
15+
16+
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.
17+
18+
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 commit comments

Comments
 (0)