Merge pull request #2 from CaptainDario/v2.1.3

V2.1.3
CaptainDario · Jun 3, 2021 · e910bc6 · e910bc6
2 parents a5a82ab + 6c90e70
commit e910bc6
Show file tree

Hide file tree

Showing 30 changed files with 93 additions and 53 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # ETL Data Reader : Changelog
 
+## v 2.1.3
+
+features:
+  - parameter to set the integer from which the folder names will start when saving to file 
+
+------------------------------------------------------------
 ## v 2.1.2
 
 fixed:

diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ pip install .\path\to\etl_data_reader_CaptainDario-2.0-py3-none-any.whl
 ```
 Or install it directly via https:
 ```bash
-pip install https://github.com/CaptainDario/ETLCDB_data_reader/releases/download/v2.1.2/etl_data_reader_CaptainDario-2.1.2-py3-none-any.whl
+pip install https://github.com/CaptainDario/ETLCDB_data_reader/releases/download/v2.1.3/etl_data_reader_CaptainDario-2.1.3-py3-none-any.whl
 ```
 Assuming you already have [downloaded the ETLCDB](http://etlcdb.db.aist.go.jp/obtaining-etl-character-database).
 You have to do some renaming of the data set folders and files.

diff --git a/docs/build/.buildinfo b/docs/build/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 736bcd7f38135bac932ee6dcc0de3dc9
+config: e9e905340ecac7d6908d98bcd879dafa
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/.doctrees/CHANGELOG.doctree b/docs/build/.doctrees/CHANGELOG.doctree
diff --git a/docs/build/.doctrees/README.doctree b/docs/build/.doctrees/README.doctree
diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle
diff --git a/docs/build/.doctrees/etl_data_reader.doctree b/docs/build/.doctrees/etl_data_reader.doctree
diff --git a/docs/build/.doctrees/getting_started.doctree b/docs/build/.doctrees/getting_started.doctree
diff --git a/docs/build/API.html b/docs/build/API.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>API &#8212; ETL_data_reader 2.1.2 documentation</title>
+    <title>API &#8212; ETL_data_reader 2.1.3 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
@@ -34,7 +34,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="getting_started.html" title="Getting started"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">API</a></li> 
       </ul>
     </div>  
@@ -107,7 +107,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="getting_started.html" title="Getting started"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">API</a></li> 
       </ul>
     </div>

diff --git a/docs/build/CHANGELOG.html b/docs/build/CHANGELOG.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>ETL Data Reader : Changelog &#8212; ETL_data_reader 2.1.2 documentation</title>
+    <title>ETL Data Reader : Changelog &#8212; ETL_data_reader 2.1.3 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
@@ -30,7 +30,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="indices_and_tables.html" title="Indices and tables"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">ETL Data Reader : Changelog</a></li> 
       </ul>
     </div>  
@@ -42,6 +42,14 @@ <h3>Navigation</h3>
 
   <div class="section" id="etl-data-reader-changelog">
 <h1>ETL Data Reader : Changelog<a class="headerlink" href="#etl-data-reader-changelog" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="v-2-1-3">
+<h2>v 2.1.3<a class="headerlink" href="#v-2-1-3" title="Permalink to this headline">¶</a></h2>
+<p>features:</p>
+<ul class="simple">
+<li><p>parameter to set the integer from which the folder names will start when saving to file</p></li>
+</ul>
+</div>
+<hr class="docutils" />
 <div class="section" id="v-2-1-2">
 <h2>v 2.1.2<a class="headerlink" href="#v-2-1-2" title="Permalink to this headline">¶</a></h2>
 <p>fixed:</p>
@@ -108,6 +116,7 @@ <h2>v 1.0:<a class="headerlink" href="#v-1-0" title="Permalink to this headline"
   <h3><a href="index.html">Table of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">ETL Data Reader : Changelog</a><ul>
+<li><a class="reference internal" href="#v-2-1-3">v 2.1.3</a></li>
 <li><a class="reference internal" href="#v-2-1-2">v 2.1.2</a></li>
 <li><a class="reference internal" href="#v-2-1-1">v 2.1.1</a></li>
 <li><a class="reference internal" href="#v-2-1">v 2.1</a></li>
@@ -153,7 +162,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="indices_and_tables.html" title="Indices and tables"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">ETL Data Reader : Changelog</a></li> 
       </ul>
     </div>

diff --git a/docs/build/README.html b/docs/build/README.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>ETLCDB_data_reader &#8212; ETL_data_reader 2.1.2 documentation</title>
+    <title>ETLCDB_data_reader &#8212; ETL_data_reader 2.1.3 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">ETLCDB_data_reader</a></li> 
       </ul>
     </div>  
@@ -189,7 +189,7 @@ <h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">
 </pre></div>
 </div>
 <p>Or install it directly via https:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install https://github.com/CaptainDario/ETLCDB_data_reader/releases/download/v2.1/etl_data_reader_CaptainDario-2.1-py3-none-any.whl
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install https://github.com/CaptainDario/ETLCDB_data_reader/releases/download/v2.1.3/etl_data_reader_CaptainDario-2.1.3-py3-none-any.whl
 </pre></div>
 </div>
 <p>Assuming you already have <a class="reference external" href="http://etlcdb.db.aist.go.jp/obtaining-etl-character-database">downloaded the ETLCDB</a>.
@@ -441,7 +441,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">ETLCDB_data_reader</a></li> 
       </ul>
     </div>

diff --git a/docs/build/_sources/CHANGELOG.rst.txt b/docs/build/_sources/CHANGELOG.rst.txt
@@ -2,6 +2,16 @@
 ETL Data Reader : Changelog
 ===========================
 
+v 2.1.3
+-------
+
+features:
+
+
+* parameter to set the integer from which the folder names will start when saving to file 
+
+----
+
 v 2.1.2
 -------
 

diff --git a/docs/build/_sources/README.rst.txt b/docs/build/_sources/README.rst.txt
@@ -142,7 +142,7 @@ Or install it directly via https:
 
 .. code-block:: bash
 
-   pip install https://github.com/CaptainDario/ETLCDB_data_reader/releases/download/v2.1/etl_data_reader_CaptainDario-2.1-py3-none-any.whl
+   pip install https://github.com/CaptainDario/ETLCDB_data_reader/releases/download/v2.1.3/etl_data_reader_CaptainDario-2.1.3-py3-none-any.whl
 
 Assuming you already have `downloaded the ETLCDB <http://etlcdb.db.aist.go.jp/obtaining-etl-character-database>`_.
 You have to do some renaming of the data set folders and files.

diff --git a/docs/build/_static/documentation_options.js b/docs/build/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '2.1.2',
+    VERSION: '2.1.3',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/build/etl_character_groups.html b/docs/build/etl_character_groups.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>etl_character_groups.py &#8212; ETL_data_reader 2.1.2 documentation</title>
+    <title>etl_character_groups.py &#8212; ETL_data_reader 2.1.3 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
@@ -34,7 +34,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="API.html" title="API"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_character_groups.py</a></li> 
       </ul>
@@ -146,7 +146,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="API.html" title="API"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_character_groups.py</a></li> 
       </ul>

diff --git a/docs/build/etl_codes.html b/docs/build/etl_codes.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>etl_codes.py &#8212; ETL_data_reader 2.1.2 documentation</title>
+    <title>etl_codes.py &#8212; ETL_data_reader 2.1.3 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
@@ -34,7 +34,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="etl_character_groups.html" title="etl_character_groups.py"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_codes.py</a></li> 
       </ul>
@@ -249,7 +249,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="etl_character_groups.html" title="etl_character_groups.py"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_codes.py</a></li> 
       </ul>

diff --git a/docs/build/etl_data_names.html b/docs/build/etl_data_names.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>etl_data_names.py &#8212; ETL_data_reader 2.1.2 documentation</title>
+    <title>etl_data_names.py &#8212; ETL_data_reader 2.1.3 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
@@ -34,7 +34,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="etl_codes.html" title="etl_codes.py"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_data_names.py</a></li> 
       </ul>
@@ -187,7 +187,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="etl_codes.html" title="etl_codes.py"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_data_names.py</a></li> 
       </ul>

diff --git a/docs/build/etl_data_reader.html b/docs/build/etl_data_reader.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>etl_data_reader.py &#8212; ETL_data_reader 2.1.2 documentation</title>
+    <title>etl_data_reader.py &#8212; ETL_data_reader 2.1.3 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
@@ -34,7 +34,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="etl_data_names.html" title="etl_data_names.py"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_data_reader.py</a></li> 
       </ul>
@@ -370,7 +370,7 @@ <h3>Navigation</h3>
 
 <dl class="py method">
 <dt id="etl_data_reader.ETLDataReader.save_to_file">
-<code class="sig-name descname">save_to_file</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span><span class="p">:</span> <span class="n">numpy.ndarray</span></em>, <em class="sig-param"><span class="n">y</span><span class="p">:</span> <span class="n">numpy.ndarray</span></em>, <em class="sig-param"><span class="n">save_to</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span><a class="headerlink" href="#etl_data_reader.ETLDataReader.save_to_file" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname">save_to_file</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span><span class="p">:</span> <span class="n">numpy.ndarray</span></em>, <em class="sig-param"><span class="n">y</span><span class="p">:</span> <span class="n">numpy.ndarray</span></em>, <em class="sig-param"><span class="n">save_to</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">name</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">1</span></em><span class="sig-paren">)</span><a class="headerlink" href="#etl_data_reader.ETLDataReader.save_to_file" title="Permalink to this definition">¶</a></dt>
 <dd><p>Saves all images and labels to file.</p>
 <p>Creates a folder structure in which all images for one label are
 stored in a folder. The names of these folders are the labels encoded
@@ -389,6 +389,7 @@ <h3>Navigation</h3>
 <li><p><strong>x</strong> – a numpy array containing all images.</p></li>
 <li><p><strong>y</strong> – a numpy array containing all labels.</p></li>
 <li><p><strong>save_to</strong> – the path to the folder where the image and labels should be saved</p></li>
+<li><p><strong>name</strong> – an integer from which the names should start (Defaults to 1).</p></li>
 </ul>
 </dd>
 </dl>
@@ -467,7 +468,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="etl_data_names.html" title="etl_data_names.py"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_data_reader.py</a></li> 
       </ul>

diff --git a/docs/build/etl_data_set_info.html b/docs/build/etl_data_set_info.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>etl_data_set_info.py &#8212; ETL_data_reader 2.1.2 documentation</title>
+    <title>etl_data_set_info.py &#8212; ETL_data_reader 2.1.3 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
@@ -34,7 +34,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="etl_data_reader.html" title="etl_data_reader.py"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_data_set_info.py</a></li> 
       </ul>
@@ -141,7 +141,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="etl_data_reader.html" title="etl_data_reader.py"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">etl_data_set_info.py</a></li> 
       </ul>

diff --git a/docs/build/genindex.html b/docs/build/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; ETL_data_reader 2.1.2 documentation</title>
+    <title>Index &#8212; ETL_data_reader 2.1.3 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>  
@@ -343,7 +343,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>