Update docs

haruishi43 · Oct 30, 2022 · a6d7f13 · a6d7f13
1 parent 214327f
commit a6d7f13
Show file tree

Hide file tree

Showing 68 changed files with 2,652 additions and 519 deletions.
diff --git a/_modules/index.html b/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; pyEdgeEval 0.1.3 documentation</title>
+  <title>Overview: module code &mdash; pyEdgeEval 0.2.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../index.html" class="icon icon-home"> pyEdgeEval
           </a>
               <div class="version">
-                0.1.3
+                0.2.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -41,10 +41,12 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../readme_link.html">Edge Evaluation Tools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../readme_link.html">Python Edge Evaluation Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../readme_link.html#installation">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../readme_link.html#converting-cityscapes-dataset-for-sbd">Converting Cityscapes Dataset for SBD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../readme_link.html#evaluation-for-each-datasets">Evaluation for each datasets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../readme_link.html#acknowledgements">Acknowledgements</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../readme_link.html#license">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../readme_link.html#development">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../pyEdgeEval.html">pyEdgeEval package</a></li>
 </ul>
 
@@ -100,6 +102,10 @@ <h1>All modules for which code is available</h1>
 <li><a href="pyEdgeEval/evaluators/half_cityscapes.html">pyEdgeEval.evaluators.half_cityscapes</a></li>
 <li><a href="pyEdgeEval/evaluators/otf_cityscapes.html">pyEdgeEval.evaluators.otf_cityscapes</a></li>
 <li><a href="pyEdgeEval/evaluators/sbd.html">pyEdgeEval.evaluators.sbd</a></li>
+<li><a href="pyEdgeEval/helpers/convert_cityscapes.html">pyEdgeEval.helpers.convert_cityscapes</a></li>
+<li><a href="pyEdgeEval/helpers/evaluate_bsds500.html">pyEdgeEval.helpers.evaluate_bsds500</a></li>
+<li><a href="pyEdgeEval/helpers/evaluate_cityscapes.html">pyEdgeEval.helpers.evaluate_cityscapes</a></li>
+<li><a href="pyEdgeEval/helpers/evaluate_sbd.html">pyEdgeEval.helpers.evaluate_sbd</a></li>
 <li><a href="pyEdgeEval/preprocess/nms/fast_nms.html">pyEdgeEval.preprocess.nms.fast_nms</a></li>
 <li><a href="pyEdgeEval/preprocess/nms/toolbox.html">pyEdgeEval.preprocess.nms.toolbox</a></li>
 <li><a href="pyEdgeEval/preprocess/thin/bwmorph_thin.html">pyEdgeEval.preprocess.thin.bwmorph_thin</a></li>

diff --git a/_modules/pyEdgeEval/common/binary_label/calculate_metrics.html b/_modules/pyEdgeEval/common/binary_label/calculate_metrics.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyEdgeEval.common.binary_label.calculate_metrics &mdash; pyEdgeEval 0.1.3 documentation</title>
+  <title>pyEdgeEval.common.binary_label.calculate_metrics &mdash; pyEdgeEval 0.2.0 documentation</title>
       <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/custom.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../../../../index.html" class="icon icon-home"> pyEdgeEval
           </a>
               <div class="version">
-                0.1.3
+                0.2.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -41,10 +41,12 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Edge Evaluation Tools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Python Edge Evaluation Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#installation">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#converting-cityscapes-dataset-for-sbd">Converting Cityscapes Dataset for SBD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#evaluation-for-each-datasets">Evaluation for each datasets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#acknowledgements">Acknowledgements</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#license">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#development">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../pyEdgeEval.html">pyEdgeEval package</a></li>
 </ul>
 

diff --git a/_modules/pyEdgeEval/common/binary_label/evaluate_boundaries.html b/_modules/pyEdgeEval/common/binary_label/evaluate_boundaries.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyEdgeEval.common.binary_label.evaluate_boundaries &mdash; pyEdgeEval 0.1.3 documentation</title>
+  <title>pyEdgeEval.common.binary_label.evaluate_boundaries &mdash; pyEdgeEval 0.2.0 documentation</title>
       <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/custom.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../../../../index.html" class="icon icon-home"> pyEdgeEval
           </a>
               <div class="version">
-                0.1.3
+                0.2.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -41,10 +41,12 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Edge Evaluation Tools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Python Edge Evaluation Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#installation">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#converting-cityscapes-dataset-for-sbd">Converting Cityscapes Dataset for SBD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#evaluation-for-each-datasets">Evaluation for each datasets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#acknowledgements">Acknowledgements</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#license">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#development">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../pyEdgeEval.html">pyEdgeEval package</a></li>
 </ul>
 

diff --git a/_modules/pyEdgeEval/common/binary_label/io.html b/_modules/pyEdgeEval/common/binary_label/io.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyEdgeEval.common.binary_label.io &mdash; pyEdgeEval 0.1.3 documentation</title>
+  <title>pyEdgeEval.common.binary_label.io &mdash; pyEdgeEval 0.2.0 documentation</title>
       <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/custom.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../../../../index.html" class="icon icon-home"> pyEdgeEval
           </a>
               <div class="version">
-                0.1.3
+                0.2.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -41,10 +41,12 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Edge Evaluation Tools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Python Edge Evaluation Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#installation">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#converting-cityscapes-dataset-for-sbd">Converting Cityscapes Dataset for SBD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#evaluation-for-each-datasets">Evaluation for each datasets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#acknowledgements">Acknowledgements</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#license">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#development">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../pyEdgeEval.html">pyEdgeEval package</a></li>
 </ul>
 

diff --git a/_modules/pyEdgeEval/common/binary_label/visualize.html b/_modules/pyEdgeEval/common/binary_label/visualize.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyEdgeEval.common.binary_label.visualize &mdash; pyEdgeEval 0.1.3 documentation</title>
+  <title>pyEdgeEval.common.binary_label.visualize &mdash; pyEdgeEval 0.2.0 documentation</title>
       <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/custom.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../../../../index.html" class="icon icon-home"> pyEdgeEval
           </a>
               <div class="version">
-                0.1.3
+                0.2.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -41,10 +41,12 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Edge Evaluation Tools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Python Edge Evaluation Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#installation">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#converting-cityscapes-dataset-for-sbd">Converting Cityscapes Dataset for SBD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#evaluation-for-each-datasets">Evaluation for each datasets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#acknowledgements">Acknowledgements</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#license">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#development">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../pyEdgeEval.html">pyEdgeEval package</a></li>
 </ul>
 

diff --git a/_modules/pyEdgeEval/common/metrics.html b/_modules/pyEdgeEval/common/metrics.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyEdgeEval.common.metrics &mdash; pyEdgeEval 0.1.3 documentation</title>
+  <title>pyEdgeEval.common.metrics &mdash; pyEdgeEval 0.2.0 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/custom.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../../../index.html" class="icon icon-home"> pyEdgeEval
           </a>
               <div class="version">
-                0.1.3
+                0.2.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -41,10 +41,12 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../readme_link.html">Edge Evaluation Tools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../readme_link.html">Python Edge Evaluation Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../readme_link.html#installation">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../readme_link.html#converting-cityscapes-dataset-for-sbd">Converting Cityscapes Dataset for SBD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../readme_link.html#evaluation-for-each-datasets">Evaluation for each datasets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../readme_link.html#acknowledgements">Acknowledgements</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../readme_link.html#license">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../readme_link.html#development">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../pyEdgeEval.html">pyEdgeEval package</a></li>
 </ul>
 

diff --git a/_modules/pyEdgeEval/common/multi_label/calculate_metrics.html b/_modules/pyEdgeEval/common/multi_label/calculate_metrics.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyEdgeEval.common.multi_label.calculate_metrics &mdash; pyEdgeEval 0.1.3 documentation</title>
+  <title>pyEdgeEval.common.multi_label.calculate_metrics &mdash; pyEdgeEval 0.2.0 documentation</title>
       <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../../_static/css/custom.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../../../../index.html" class="icon icon-home"> pyEdgeEval
           </a>
               <div class="version">
-                0.1.3
+                0.2.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -41,10 +41,12 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Edge Evaluation Tools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html">Python Edge Evaluation Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#installation">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#converting-cityscapes-dataset-for-sbd">Converting Cityscapes Dataset for SBD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#evaluation-for-each-datasets">Evaluation for each datasets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#acknowledgements">Acknowledgements</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#license">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../readme_link.html#development">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../pyEdgeEval.html">pyEdgeEval package</a></li>
 </ul>