Update documentation

healthonrails · Mar 25, 2024 · 7e2b927 · 7e2b927
1 parent 0e501b5
commit 7e2b927
Show file tree

Hide file tree

Showing 121 changed files with 24,100 additions and 1,950 deletions.
diff --git a/_images/00002895_7.jpg b/_images/00002895_7.jpg
diff --git a/_images/00002895_7_mask.png b/_images/00002895_7_mask.png
diff --git a/_images/mouse_keypoints.png b/_images/mouse_keypoints.png
diff --git a/_images/predicted_polygons.png b/_images/predicted_polygons.png
diff --git a/_images/threshold_based_segmentation.png b/_images/threshold_based_segmentation.png
diff --git a/_images/track_animals.png b/_images/track_animals.png
diff --git a/_modules/annolid/annotation/coco2yolo.html b/_modules/annolid/annotation/coco2yolo.html
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,124 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; annolid v1.0.1 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+        <script src="../_static/language_data.js"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            annolid
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="../guide.html">Annolid User Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../install.html">Install Annolid</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../install.html#install-detectron2-locally">Install Detectron2 locally</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../install.html#install-detectron2-on-google-colab">Install Detectron2 on Google Colab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../install.html#optional-install-older-version-of-pytorch-for-yolact">Optional: Install older version of Pytorch for YOLACT</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../extract_frames.html">Extract desired number of frames from a video based on optical flow</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../extract_frames.html#display-optical-flow-while-extracting-frames-with-show-flow-true">Display optical flow while extracting frames with <strong>–show_flow=True</strong></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../extract_frames.html#save-all-the-frames-as-images">Save all the frames as images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../extract_frames.html#select-frames-randomly-by-reservoir-sampling">Select frames randomly by reservoir sampling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../extract_frames.html#extract-all-the-key-frames-from-a-video-used-by-the-compression-methods">Extract all the key frames from a video used by the compression methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../track_animals.html">Track animals and Auto labeling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../track_animals.html#output-csv-format">Output CSV format</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../keypoints_definitions.html">Config keypoint connection rules, events, and instances</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html">Threshold based object segmenation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#convert-wmv-format-to-mp4-format-using-ffmpeg">Convert WMV format to mp4 format using ffmpeg</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#save-the-extracted-frames-to-a-user-selected-output-directory">Save the extracted frames to a user selected output directory</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#how-to-track-multiple-objects-in-the-video">How to track multiple objects in the video?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#how-to-convert-coco-annonation-format-to-yolov5-format">How to convert coco annonation format to YOLOV5 format?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#how-to-train-a-custom-yolov5-model">How to train a custom YOLOV5 model?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#how-to-track-objects-in-a-video-with-the-trained-model">How to track objects in a video with the trained model?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#how-to-convert-labelme-labeled-dataset-to-coco-format">How to convert labelme labeled dataset to COCO format?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#how-to-train-a-yolact-model-with-a-custom-dataset">How to train a YOLACT model with a custom dataset?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#how-to-evaluate-a-video-based-on-a-trained-model">How to evaluate a video based on a trained model?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#convert-the-tracking-results-csv-file-to-glitter2-csv-format">Convert the tracking results csv file to Glitter2 csv format</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../faqs.html#convert-the-keypoint-annotations-to-labelme-format">Convert the keypoint annotations to labelme format</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">annolid</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="annolid/annotation/coco2yolo.html">annolid.annotation.coco2yolo</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2021, Chen Yang.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_sources/_templates/annolid.annotation.rst.txt b/_sources/_templates/annolid.annotation.rst.txt
@@ -0,0 +1,29 @@
+annolid.annotation package
+==========================
+
+Submodules
+----------
+
+annolid.annotation.coco2yolo module
+-----------------------------------
+
+.. automodule:: annolid.annotation.coco2yolo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+annolid.annotation.labelme2coco module
+--------------------------------------
+
+.. automodule:: annolid.annotation.labelme2coco
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: annolid.annotation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/_templates/annolid.data.rst.txt b/_sources/_templates/annolid.data.rst.txt
@@ -0,0 +1,21 @@
+annolid.data package
+====================
+
+Submodules
+----------
+
+annolid.data.videos module
+--------------------------
+
+.. automodule:: annolid.data.videos
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: annolid.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/_templates/annolid.datasets.rst.txt b/_sources/_templates/annolid.datasets.rst.txt
@@ -0,0 +1,21 @@
+annolid.datasets package
+========================
+
+Submodules
+----------
+
+annolid.datasets.video\_dataset module
+--------------------------------------
+
+.. automodule:: annolid.datasets.video_dataset
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: annolid.datasets
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/_templates/annolid.detector.YOLOv3.nms.ext.rst.txt b/_sources/_templates/annolid.detector.YOLOv3.nms.ext.rst.txt
@@ -0,0 +1,21 @@
+annolid.detector.YOLOv3.nms.ext package
+=======================================
+
+Submodules
+----------
+
+annolid.detector.YOLOv3.nms.ext.build module
+--------------------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.nms.ext.build
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: annolid.detector.YOLOv3.nms.ext
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/_templates/annolid.detector.YOLOv3.nms.rst.txt b/_sources/_templates/annolid.detector.YOLOv3.nms.rst.txt
@@ -0,0 +1,37 @@
+annolid.detector.YOLOv3.nms package
+===================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   annolid.detector.YOLOv3.nms.ext
+
+Submodules
+----------
+
+annolid.detector.YOLOv3.nms.nms module
+--------------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.nms.nms
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+annolid.detector.YOLOv3.nms.python\_nms module
+----------------------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.nms.python_nms
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: annolid.detector.YOLOv3.nms
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/_templates/annolid.detector.YOLOv3.rst.txt b/_sources/_templates/annolid.detector.YOLOv3.rst.txt
@@ -0,0 +1,77 @@
+annolid.detector.YOLOv3 package
+===============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   annolid.detector.YOLOv3.nms
+
+Submodules
+----------
+
+annolid.detector.YOLOv3.cfg module
+----------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.cfg
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+annolid.detector.YOLOv3.darknet module
+--------------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.darknet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+annolid.detector.YOLOv3.detect module
+-------------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.detect
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+annolid.detector.YOLOv3.detector module
+---------------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.detector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+annolid.detector.YOLOv3.region\_layer module
+--------------------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.region_layer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+annolid.detector.YOLOv3.yolo\_layer module
+------------------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.yolo_layer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+annolid.detector.YOLOv3.yolo\_utils module
+------------------------------------------
+
+.. automodule:: annolid.detector.YOLOv3.yolo_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: annolid.detector.YOLOv3
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/_templates/annolid.detector.rst.txt b/_sources/_templates/annolid.detector.rst.txt
@@ -0,0 +1,19 @@
+annolid.detector package
+========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   annolid.detector.YOLOv3
+   annolid.detector.yolov5
+
+Module contents
+---------------
+
+.. automodule:: annolid.detector
+   :members:
+   :undoc-members:
+   :show-inheritance: