Merge pull request #2828 from tombstone/minor_updates

minor updates in documentation.

research/object_detection/README.md

@@ -63,10 +63,10 @@ Extras:
       Defining your own model architecture</a><br>
   * <a href='g3doc/using_your_own_dataset.md'>
       Bringing in your own dataset</a><br>
-  * <a href='g3doc/oid_inference_and_evaluation.md'>
-      Inference and evaluation on the Open Images dataset</a><br>
   * <a href='g3doc/evaluation_protocols.md'>
       Supported object detection evaluation protocols</a><br>
+  * <a href='g3doc/oid_inference_and_evaluation.md'>
+      Inference and evaluation on the Open Images dataset</a><br>
 
 ## Getting Help
 

research/object_detection/dataset_tools/create_kitti_tf_record.py

@@ -27,7 +27,7 @@ Converts KITTI detection dataset to TFRecords with a standard format allowing
   This can be altered using the flags, see details below.
 
 Example usage:
-    python create_kitti_tf_record.py \
+    python object_detection/dataset_tools/create_kitti_tf_record.py \
         --data_dir=/home/user/kitti \
         --output_path=/home/user/kitti.record
 """

research/object_detection/dataset_tools/create_oid_tf_record.py

@@ -15,7 +15,7 @@
 r"""Creates TFRecords of Open Images dataset for object detection.
 
 Example usage:
-  ./create_oid_tf_record \
+  python object_detection/dataset_tools/create_oid_tf_record.py \
     --input_annotations_csv=/path/to/input/annotations-human-bbox.csv \
     --input_images_directory=/path/to/input/image_pixels_directory \
     --input_label_map=/path/to/input/labels_bbox_545.labelmap \

research/object_detection/dataset_tools/create_pascal_tf_record.py

@@ -16,7 +16,8 @@
 r"""Convert raw PASCAL dataset to TFRecord for object_detection.
 
 Example usage:
-    ./create_pascal_tf_record --data_dir=/home/user/VOCdevkit \
+    python object_detection/dataset_tools/create_pascal_tf_record.py \
+        --data_dir=/home/user/VOCdevkit \
         --year=VOC2012 \
         --output_path=/home/user/pascal.record
 """

research/object_detection/dataset_tools/create_pet_tf_record.py

@@ -21,7 +21,8 @@ See: O. M. Parkhi, A. Vedaldi, A. Zisserman, C. V. Jawahar
      http://www.robots.ox.ac.uk/~vgg/data/pets/
 
 Example usage:
-    ./create_pet_tf_record --data_dir=/home/user/pet \
+    python object_detection/dataset_tools/create_pet_tf_record.py \
+        --data_dir=/home/user/pet \
         --output_dir=/home/user/pet/output
 """
 

research/object_detection/g3doc/installation.md

@@ -12,9 +12,9 @@ Tensorflow Object Detection API depends on the following libraries:
 * Matplotlib
 * Tensorflow
 
-For detailed steps to install Tensorflow, follow the
-[Tensorflow installation instructions](https://www.tensorflow.org/install/).
-A typically user can install Tensorflow using one of the following commands:
+For detailed steps to install Tensorflow, follow the [Tensorflow installation
+instructions](https://www.tensorflow.org/install/). A typical user can install
+Tensorflow using one of the following commands:
 
 ``` bash
 # For CPU

research/object_detection/metrics/offline_eval_map_corloc_test.py

@@ -30,10 +30,10 @@ class OfflineEvalMapCorlocTest(tf.test.TestCase):
     result = offline_eval._generate_sharded_filenames(test_filename)
     self.assertEqual(result, [test_filename])
 
-    result = offline_eval._generate_sharded_filenames('/path/to/@3.sst')
+    result = offline_eval._generate_sharded_filenames('/path/to/@3.record')
     self.assertEqual(result, [
-        '/path/to/-00000-of-00003.sst', '/path/to/-00001-of-00003.sst',
-        '/path/to/-00002-of-00003.sst'
+        '/path/to/-00000-of-00003.record', '/path/to/-00001-of-00003.record',
+        '/path/to/-00002-of-00003.record'
     ])
 
     result = offline_eval._generate_sharded_filenames('/path/to/abc@3')
@@ -46,11 +46,11 @@ class OfflineEvalMapCorlocTest(tf.test.TestCase):
     self.assertEqual(result, ['/path/to/-00000-of-00001'])
 
   def test_generateFilenames(self):
-    test_filenames = ['/path/to/file', '/path/to/@3.sst']
+    test_filenames = ['/path/to/file', '/path/to/@3.record']
     result = offline_eval._generate_filenames(test_filenames)
     self.assertEqual(result, [
-        '/path/to/file', '/path/to/-00000-of-00003.sst',
-        '/path/to/-00001-of-00003.sst', '/path/to/-00002-of-00003.sst'
+        '/path/to/file', '/path/to/-00000-of-00003.record',
+        '/path/to/-00001-of-00003.record', '/path/to/-00002-of-00003.record'
     ])