Update docs

Author: adipandas

README.md

@@ -4,30 +4,29 @@
 # Multi-object trackers in Python
 Easy to use implementation of various multi-object tracking algorithms.
 
-[![DOI](https://zenodo.org/badge/148338463.svg)](https://zenodo.org/badge/latestdoi/148338463)   [![Upload motrackers to PyPI](https://github.com/adipandas/multi-object-tracker/actions/workflows/python-publish.yml/badge.svg)](https://github.com/adipandas/multi-object-tracker/actions/workflows/python-publish.yml)
+[![DOI](https://zenodo.org/badge/148338463.svg)](https://zenodo.org/badge/latestdoi/148338463)   
+[![Upload motrackers to PyPI](https://github.com/adipandas/multi-object-tracker/actions/workflows/python-publish.yml/badge.svg)](https://github.com/adipandas/multi-object-tracker/actions/workflows/python-publish.yml)
 
 
 `YOLOv3 + CentroidTracker` |  `TF-MobileNetSSD + CentroidTracker`
 :-------------------------:|:-------------------------:
 ![Cars with YOLO][cars-yolo-output]  |  ![Cows with tf-SSD][cows-tf-ssd-output]
 Video source: [link](https://flic.kr/p/L6qyxj) | Video source: [link](https://flic.kr/p/26WeEWy)
 
+
 ## Available Multi Object Trackers
 
-```
-CentroidTracker
-IOUTracker
-CentroidKF_Tracker
-SORT
-```
+- CentroidTracker
+- IOUTracker
+- CentroidKF_Tracker
+- SORT
+
 
 ## Available OpenCV-based object detectors:
 
-```
-detector.TF_SSDMobileNetV2
-detector.Caffe_SSDMobileNet
-detector.YOLOv3
-```
+- detector.TF_SSDMobileNetV2
+- detector.Caffe_SSDMobileNet
+- detector.YOLOv3
 
 ## Installation
 

docs/.doctrees/environment.pickle

@@ -87,7 +87,7 @@ <h1>Source code for motrackers.centroid_kf_tracker</h1><div class="highlight"><p
 
 
 <div class="viewcode-block" id="assign_tracks2detection_centroid_distances"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.centroid_kf_tracker.assign_tracks2detection_centroid_distances">[docs]</a><span class="k">def</span> <span class="nf">assign_tracks2detection_centroid_distances</span><span class="p">(</span><span class="n">bbox_tracks</span><span class="p">,</span> <span class="n">bbox_detections</span><span class="p">,</span> <span class="n">distance_threshold</span><span class="o">=</span><span class="mf">10.</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Assigns detected bounding boxes to tracked bounding boxes using IoU as a distance metric.</span>
 
 <span class="sd">    Args:</span>
@@ -149,7 +149,7 @@ <h1>Source code for motrackers.centroid_kf_tracker</h1><div class="highlight"><p
 
 
 <div class="viewcode-block" id="CentroidKF_Tracker"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.centroid_kf_tracker.CentroidKF_Tracker">[docs]</a><span class="k">class</span> <span class="nc">CentroidKF_Tracker</span><span class="p">(</span><span class="n">Tracker</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Kalman filter based tracking of multiple detected objects.</span>
 
 <span class="sd">    Args:</span>

docs/.doctrees/includeme/apidocuments.doctree

@@ -83,7 +83,7 @@ <h1>Source code for motrackers.detectors.caffe</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="Caffe_SSDMobileNet"><a class="viewcode-back" href="../../../includeme/apidocuments.html#motrackers.detectors.caffe.Caffe_SSDMobileNet">[docs]</a><span class="k">class</span> <span class="nc">Caffe_SSDMobileNet</span><span class="p">(</span><span class="n">Detector</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Caffe SSD MobileNet model for Object Detection.</span>
 
 <span class="sd">    Args:</span>

docs/.doctrees/includeme/readmefile.doctree

@@ -83,7 +83,7 @@ <h1>Source code for motrackers.detectors.detector</h1><div class="highlight"><pr
 
 
 <div class="viewcode-block" id="Detector"><a class="viewcode-back" href="../../../includeme/apidocuments.html#motrackers.detectors.detector.Detector">[docs]</a><span class="k">class</span> <span class="nc">Detector</span><span class="p">:</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Abstract class for detector.</span>
 
 <span class="sd">    Args:</span>
@@ -105,7 +105,7 @@ <h1>Source code for motrackers.detectors.detector</h1><div class="highlight"><pr
             <span class="bp">self</span><span class="o">.</span><span class="n">bbox_colors</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">255</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,))</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">object_names</span><span class="o">.</span><span class="n">keys</span><span class="p">()}</span>
 
 <div class="viewcode-block" id="Detector.forward"><a class="viewcode-back" href="../../../includeme/apidocuments.html#motrackers.detectors.detector.Detector.forward">[docs]</a>    <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">image</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Forward pass for the detector with input image.</span>
 
 <span class="sd">        Args:</span>
@@ -117,7 +117,7 @@ <h1>Source code for motrackers.detectors.detector</h1><div class="highlight"><pr
         <span class="k">raise</span> <span class="bp">NotImplemented</span></div>
 
 <div class="viewcode-block" id="Detector.detect"><a class="viewcode-back" href="../../../includeme/apidocuments.html#motrackers.detectors.detector.Detector.detect">[docs]</a>    <span class="k">def</span> <span class="nf">detect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">image</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Detect objects in the input image.</span>
 
 <span class="sd">        Args:</span>
@@ -157,7 +157,7 @@ <h1>Source code for motrackers.detectors.detector</h1><div class="highlight"><pr
             <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([]),</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([]),</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([])</span></div>
 
 <div class="viewcode-block" id="Detector.draw_bboxes"><a class="viewcode-back" href="../../../includeme/apidocuments.html#motrackers.detectors.detector.Detector.draw_bboxes">[docs]</a>    <span class="k">def</span> <span class="nf">draw_bboxes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">image</span><span class="p">,</span> <span class="n">bboxes</span><span class="p">,</span> <span class="n">confidences</span><span class="p">,</span> <span class="n">class_ids</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Draw the bounding boxes about detected objects in the image.</span>
 
 <span class="sd">        Args:</span>

docs/.doctrees/index.doctree

@@ -83,7 +83,7 @@ <h1>Source code for motrackers.detectors.tf</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="TF_SSDMobileNetV2"><a class="viewcode-back" href="../../../includeme/apidocuments.html#motrackers.detectors.tf.TF_SSDMobileNetV2">[docs]</a><span class="k">class</span> <span class="nc">TF_SSDMobileNetV2</span><span class="p">(</span><span class="n">Detector</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Tensorflow SSD MobileNetv2 model for Object Detection.</span>
 
 <span class="sd">    Args:</span>

docs/_modules/motrackers/centroid_kf_tracker.html

@@ -84,7 +84,7 @@ <h1>Source code for motrackers.detectors.yolo</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="YOLOv3"><a class="viewcode-back" href="../../../includeme/apidocuments.html#motrackers.detectors.yolo.YOLOv3">[docs]</a><span class="k">class</span> <span class="nc">YOLOv3</span><span class="p">(</span><span class="n">Detector</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    YOLOv3 Object Detector Module.</span>
 
 <span class="sd">    Args:</span>

docs/_modules/motrackers/detectors/caffe.html

@@ -82,7 +82,7 @@ <h1>Source code for motrackers.iou_tracker</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="IOUTracker"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.iou_tracker.IOUTracker">[docs]</a><span class="k">class</span> <span class="nc">IOUTracker</span><span class="p">(</span><span class="n">Tracker</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Intersection over Union Tracker.</span>
 
 <span class="sd">    References</span>

docs/_modules/motrackers/detectors/detector.html

@@ -81,7 +81,7 @@ <h1>Source code for motrackers.kalman_tracker</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="KalmanFilter"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.kalman_tracker.KalmanFilter">[docs]</a><span class="k">class</span> <span class="nc">KalmanFilter</span><span class="p">:</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Kalman Filter Implementation.</span>
 
 <span class="sd">    Args:</span>
@@ -124,7 +124,7 @@ <h1>Source code for motrackers.kalman_tracker</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">state_size</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span> <span class="k">if</span> <span class="n">initial_state</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">initial_state</span>
 
 <div class="viewcode-block" id="KalmanFilter.predict"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.kalman_tracker.KalmanFilter.predict">[docs]</a>    <span class="k">def</span> <span class="nf">predict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">u</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Prediction step of Kalman Filter.</span>
 
 <span class="sd">        Args:</span>
@@ -143,7 +143,7 @@ <h1>Source code for motrackers.kalman_tracker</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">x</span></div>
 
 <div class="viewcode-block" id="KalmanFilter.update"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.kalman_tracker.KalmanFilter.update">[docs]</a>    <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">z</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Measurement update of Kalman Filter.</span>
 
 <span class="sd">        Args:</span>
@@ -169,7 +169,7 @@ <h1>Source code for motrackers.kalman_tracker</h1><div class="highlight"><pre>
 
 
 <span class="k">def</span> <span class="nf">get_process_covariance_matrix</span><span class="p">(</span><span class="n">dt</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Generates a process noise covariance matrix for constant acceleration motion.</span>
 
 <span class="sd">    Args:</span>
@@ -193,7 +193,7 @@ <h1>Source code for motrackers.kalman_tracker</h1><div class="highlight"><pre>
 
 
 <span class="k">def</span> <span class="nf">get_transition_matrix</span><span class="p">(</span><span class="n">dt</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Generate the transition matrix for constant acceleration motion.</span>
 
 <span class="sd">    Args:</span>
@@ -207,7 +207,7 @@ <h1>Source code for motrackers.kalman_tracker</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="KFTrackerConstantAcceleration"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.kalman_tracker.KFTrackerConstantAcceleration">[docs]</a><span class="k">class</span> <span class="nc">KFTrackerConstantAcceleration</span><span class="p">(</span><span class="n">KalmanFilter</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Kalman Filter with constant acceleration kinematic model.</span>
 
 <span class="sd">    Args:</span>
@@ -279,7 +279,7 @@ <h1>Source code for motrackers.kalman_tracker</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="KFTrackerSORT"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.kalman_tracker.KFTrackerSORT">[docs]</a><span class="k">class</span> <span class="nc">KFTrackerSORT</span><span class="p">(</span><span class="n">KalmanFilter</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Kalman filter for ``SORT``.</span>
 
 <span class="sd">    Args:</span>

docs/_modules/motrackers/detectors/tf.html

@@ -85,7 +85,7 @@ <h1>Source code for motrackers.sort_tracker</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="assign_tracks2detection_iou"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.sort_tracker.assign_tracks2detection_iou">[docs]</a><span class="k">def</span> <span class="nf">assign_tracks2detection_iou</span><span class="p">(</span><span class="n">bbox_tracks</span><span class="p">,</span> <span class="n">bbox_detections</span><span class="p">,</span> <span class="n">iou_threshold</span><span class="o">=</span><span class="mf">0.3</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Assigns detected bounding boxes to tracked bounding boxes using IoU as a distance metric.</span>
 
 <span class="sd">    Args:</span>
@@ -142,7 +142,7 @@ <h1>Source code for motrackers.sort_tracker</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="SORT"><a class="viewcode-back" href="../../includeme/apidocuments.html#motrackers.sort_tracker.SORT">[docs]</a><span class="k">class</span> <span class="nc">SORT</span><span class="p">(</span><span class="n">CentroidKF_Tracker</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    SORT - Multi object tracker.</span>
 
 <span class="sd">    Args:</span>