basic examples updated, matplotlib v.2.0.2 req. added

Author: Kismuz

README.md

@@ -42,22 +42,28 @@ I have no idea what kind of algorithm and setup will solve it [if any]. Explore
 
 ****
 ### <a name="install"></a>[Installation](#contents)
-- Btgym requires:  `gym[atari]`, `tensorflow`, `opencv-python`,
-                   `backtrader`, `pandas`, `numpy`, `scipy`, `pyzmq`,
-                   `matplotlib`,`pillow`, `ipython`, `psutil`.
-- Clone or copy btgym repository to local disk, cd to it and run: `pip install -e . `
-to install package and all dependencies:
-``` 
-git clone https://github.com/Kismuz/btgym.git
-cd btgym
-pip install -e .
-```
-- To update to latest version:
-```
-cd btgym
-git pull
-pip install --upgrade -e .
-```
+It is highly recommended to run BTGym in designated virtual environment.
+
+Clone or copy btgym repository to local disk, cd to it and run: `pip install -e .` to install package and all dependencies:
+
+    git clone https://github.com/Kismuz/btgym.git
+
+    cd btgym
+
+    pip install -e .
+
+To update to latest version::
+
+    cd btgym
+
+    git pull
+
+    pip install --upgrade -e .
+
+###### Note:
+BTGym requres Matplotlib version 2.0.2, downgrade your installation if you have version 2.1:
+
+    pip install matplotlib==2.0.2
 
 ****
 ### <a name="start"></a>[Quickstart](#contents)
@@ -71,75 +77,19 @@ MyEnvironment = BTgymEnv(filename='../examples/data/DAT_ASCII_EURUSD_M1_2016.csv
 Adding more controls may look like:
 ```python
 from btgym import BTgymEnv
- 
+
 MyEnvironment = BTgymEnv(filename='../examples/data/DAT_ASCII_EURUSD_M1_2016.csv',
-                         episode_len_days=2,
-                         episode_len_hours=23,
-                         episode_len_minutes=55,
+                         episode_duration={'days': 2, 'hours': 23, 'minutes': 55},
                          drawdown_call=50,
                          state_shape=(4,20),
                          port=5555,
                          verbose=1,
                          )
-                 
-```
-Same one but registering environment in Gym preferred way:
-```python
-import gym
-from btgym import BTgymEnv
-  
-env_params = dict(filename='../examples/data/DAT_ASCII_EURUSD_M1_2016.csv',
-                  episode_len_days=2,
-                  episode_len_hours=23,
-                  episode_len_minutes=55,
-                  drawdown_call=50,
-                  state_shape=(20,4),
-                  port=5555,
-                  verbose=1,
-                  )
-                  
-gym.envs.register(id='backtrader-v5555', entry_point='btgym:BTgymEnv', kwargs=env_params,)
-                  
-MyEnvironment = gym.make('backtrader-v5555')
 ```
 
-Maximum environment flexibility is achieved by explicitly defining and passing `Dataset` and `Cerebro` instances:
-```python
-from gym import spaces
-import backtrader as bt
-from btgym import BTgymDataset, BTgymBaseStrategy, BTgymEnv
- 
-MyCerebro = bt.Cerebro()
-MyCerebro.addstrategy(BTgymBaseStrategy,
-                      state_shape={'raw_state': spaces.Box(low=0,high=1,shape=(20,4))},
-                      skip_frame=5,
-                      state_low=None,
-                      state_high=None,
-                      drawdown_call=50,
-                      )
- 
-MyCerebro.broker.setcash(100.0)
-MyCerebro.broker.setcommission(commission=0.001)
-MyCerebro.addsizer(bt.sizers.SizerFix, stake=10)
-MyCerebro.addanalyzer(bt.analyzers.DrawDown)
- 
-MyDataset = BTgymDataset(filename='../examples/data/DAT_ASCII_EURUSD_M1_2016.csv',
-                         start_weekdays=[0, 1, 2, 4], 
-                         start_00=True, 
-                         episode_len_days=0, 
-                         episode_len_hours=23,
-                         episode_len_minutes=55,
-                         time_gap_days=0,
-                         time_gap_hours=5,
-                         )
- 
-MyEnvironment = BTgymEnv(dataset=MyDataset,
-                         engine=MyCerebro,
-                         port=5555,
-                         verbose=1,
-                         )
-```
-###### See how-to's in [`examples`](./examples) directory.
+###### See more options at [Documentation: Quickstart >>](https://kismuz.github.io/btgym/intro.html#quickstart)
+
+###### and how-to's in [Examples directory >>](./examples).
 ****
 ### <a name="description"></a> [General description](#contents)
 #### <a name="problem"></a> Problem setting
@@ -227,7 +177,7 @@ Consider a discrete-time finite-horizon partially observable Markov decision pro
 ****
 
 
-### <a name="reference"></a> [DOCs and API Reference](https://kismuz.github.io/btgym/)
+### <a name="reference"></a> [Documentation and API Reference >>](https://kismuz.github.io/btgym/)
 
 ****
 ### <a name="issues"></a> [Current issues and limitations:](#title)

btgym/rendering/plotter.py

@@ -72,7 +72,7 @@ def run(self):
                                 iplot=False,
                                 figfilename='_tmp_btgym_render.png',
                                )[0][0]
-
+        #fig.canvas.draw()
         rgb_string = fig.canvas.tostring_rgb()
         rgb_shape = fig.canvas.get_width_height()[::-1] + (3,)
         rgb_array = np.fromstring(rgb_string, dtype=np.uint8, sep='')

docs/.doctrees/environment.pickle

@@ -245,7 +245,7 @@ <h1>Source code for btgym.rendering.plotter</h1><div class="highlight"><pre>
                                 <span class="n">iplot</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
                                 <span class="n">figfilename</span><span class="o">=</span><span class="s1">&#39;_tmp_btgym_render.png&#39;</span><span class="p">,</span>
                                <span class="p">)[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
-
+        <span class="c1">#fig.canvas.draw()</span>
         <span class="n">rgb_string</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">tostring_rgb</span><span class="p">()</span>
         <span class="n">rgb_shape</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">get_width_height</span><span class="p">()[::</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="mi">3</span><span class="p">,)</span>
         <span class="n">rgb_array</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">rgb_string</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">uint8</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span>

docs/.doctrees/intro.doctree

@@ -30,6 +30,8 @@ I have no idea what kind of algorithm and setup will solve it [if any]. Explore
 Installation
 ------------
 
+It is highly recommended to run BTGym in designated virtual environment.
+
 Clone or copy btgym repository to local disk, cd to it and run: `pip install -e .` to install package and all dependencies::
 
     git clone https://github.com/Kismuz/btgym.git
@@ -46,6 +48,11 @@ To update to latest version::
 
     pip install --upgrade -e .
 
+Note:
+    BTGym requres Matplotlib version 2.0.2, downgrade your installation if you have version 2.1::
+
+        pip install matplotlib==2.0.2
+
 Quickstart
 ----------
 
@@ -60,9 +67,7 @@ Adding more controls may look like::
     from btgym import BTgymEnv
 
     MyEnvironment = BTgymEnv(filename='../examples/data/DAT_ASCII_EURUSD_M1_2016.csv',
-                             episode_len_days=2,
-                             episode_len_hours=23,
-                             episode_len_minutes=55,
+                             episode_duration={'days': 2, 'hours': 23, 'minutes': 55},
                              drawdown_call=50,
                              state_shape=(4,20),
                              port=5555,
@@ -76,9 +81,7 @@ Same one but registering environment in Gym preferred way::
     from btgym import BTgymEnv
 
     env_params = dict(filename='../examples/data/DAT_ASCII_EURUSD_M1_2016.csv',
-                      episode_len_days=2,
-                      episode_len_hours=23,
-                      episode_len_minutes=55,
+                      episode_duration={'days': 2, 'hours': 23, 'minutes': 55},
                       drawdown_call=50,
                       state_shape=(20,4),
                       port=5555,
@@ -94,7 +97,7 @@ Maximum environment flexibility is achieved by explicitly defining and passing `
 
     from gym import spaces
     import backtrader as bt
-    from btgym import BTgymDataset, BTgymStrategy, BTgymEnv
+    from btgym import BTgymDataset, BTgymBaseStrategy, BTgymEnv
 
     MyCerebro = bt.Cerebro()
     MyCerebro.addstrategy(BTgymStrategy,
@@ -113,11 +116,8 @@ Maximum environment flexibility is achieved by explicitly defining and passing `
     MyDataset = BTgymDataset(filename='../examples/data/DAT_ASCII_EURUSD_M1_2016.csv',
                              start_weekdays=[0, 1, 2, 4],
                              start_00=True,
-                             episode_len_days=0,
-                             episode_len_hours=23,
-                             episode_len_minutes=55,
-                             time_gap_days=0,
-                             time_gap_hours=5,
+                             episode_duration={'days': 0, 'hours': 23, 'minutes': 55},
+                             time_gap={'hours': 5},
                              )
 
     MyEnvironment = BTgymEnv(dataset=MyDataset,

docs/_modules/btgym/rendering/plotter.html

@@ -102,7 +102,7 @@
 <li class="toctree-l1"><a class="reference internal" href="btgym.html#module-btgym.dataserver">btgym.dataserver module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="btgym.html#module-btgym.server">btgym.server module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="btgym.html#module-btgym.spaces">btgym.spaces module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="btgym.html#module-btgym.strategy">btgym.strategy module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="btgym.strategy.html">btgym.strategy package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="btgym.monitor.html">btgym.monitor package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="btgym.rendering.html">btgym.rendering package</a></li>
 </ul>
@@ -196,6 +196,7 @@ <h1>Package Description<a class="headerlink" href="#package-description" title="
 </div>
 <div class="section" id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
+<p>It is highly recommended to run BTGym in designated virtual environment.</p>
 <p>Clone or copy btgym repository to local disk, cd to it and run: <cite>pip install -e .</cite> to install package and all dependencies:</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">Kismuz</span><span class="o">/</span><span class="n">btgym</span><span class="o">.</span><span class="n">git</span>
 
@@ -212,6 +213,14 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="o">-</span><span class="n">e</span> <span class="o">.</span>
 </pre></div>
 </div>
+<dl class="docutils">
+<dt>Note:</dt>
+<dd><p class="first">BTGym requres Matplotlib version 2.0.2, downgrade your installation if you have version 2.1:</p>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">matplotlib</span><span class="o">==</span><span class="mf">2.0</span><span class="o">.</span><span class="mi">2</span>
+</pre></div>
+</div>
+</dd>
+</dl>
 </div>
 <div class="section" id="quickstart">
 <h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h1>
@@ -225,9 +234,7 @@ <h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">btgym</span> <span class="k">import</span> <span class="n">BTgymEnv</span>
 
 <span class="n">MyEnvironment</span> <span class="o">=</span> <span class="n">BTgymEnv</span><span class="p">(</span><span class="n">filename</span><span class="o">=</span><span class="s1">&#39;../examples/data/DAT_ASCII_EURUSD_M1_2016.csv&#39;</span><span class="p">,</span>
-                         <span class="n">episode_len_days</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
-                         <span class="n">episode_len_hours</span><span class="o">=</span><span class="mi">23</span><span class="p">,</span>
-                         <span class="n">episode_len_minutes</span><span class="o">=</span><span class="mi">55</span><span class="p">,</span>
+                         <span class="n">episode_duration</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;days&#39;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">&#39;hours&#39;</span><span class="p">:</span> <span class="mi">23</span><span class="p">,</span> <span class="s1">&#39;minutes&#39;</span><span class="p">:</span> <span class="mi">55</span><span class="p">},</span>
                          <span class="n">drawdown_call</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span>
                          <span class="n">state_shape</span><span class="o">=</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span><span class="mi">20</span><span class="p">),</span>
                          <span class="n">port</span><span class="o">=</span><span class="mi">5555</span><span class="p">,</span>
@@ -240,9 +247,7 @@ <h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this
 <span class="kn">from</span> <span class="nn">btgym</span> <span class="k">import</span> <span class="n">BTgymEnv</span>
 
 <span class="n">env_params</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">filename</span><span class="o">=</span><span class="s1">&#39;../examples/data/DAT_ASCII_EURUSD_M1_2016.csv&#39;</span><span class="p">,</span>
-                  <span class="n">episode_len_days</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
-                  <span class="n">episode_len_hours</span><span class="o">=</span><span class="mi">23</span><span class="p">,</span>
-                  <span class="n">episode_len_minutes</span><span class="o">=</span><span class="mi">55</span><span class="p">,</span>
+                  <span class="n">episode_duration</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;days&#39;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">&#39;hours&#39;</span><span class="p">:</span> <span class="mi">23</span><span class="p">,</span> <span class="s1">&#39;minutes&#39;</span><span class="p">:</span> <span class="mi">55</span><span class="p">},</span>
                   <span class="n">drawdown_call</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span>
                   <span class="n">state_shape</span><span class="o">=</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">4</span><span class="p">),</span>
                   <span class="n">port</span><span class="o">=</span><span class="mi">5555</span><span class="p">,</span>
@@ -257,7 +262,7 @@ <h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this
 <p>Maximum environment flexibility is achieved by explicitly defining and passing <cite>Dataset</cite> and <cite>Cerebro</cite> instances:</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">gym</span> <span class="k">import</span> <span class="n">spaces</span>
 <span class="kn">import</span> <span class="nn">backtrader</span> <span class="k">as</span> <span class="nn">bt</span>
-<span class="kn">from</span> <span class="nn">btgym</span> <span class="k">import</span> <span class="n">BTgymDataset</span><span class="p">,</span> <span class="n">BTgymStrategy</span><span class="p">,</span> <span class="n">BTgymEnv</span>
+<span class="kn">from</span> <span class="nn">btgym</span> <span class="k">import</span> <span class="n">BTgymDataset</span><span class="p">,</span> <span class="n">BTgymBaseStrategy</span><span class="p">,</span> <span class="n">BTgymEnv</span>
 
 <span class="n">MyCerebro</span> <span class="o">=</span> <span class="n">bt</span><span class="o">.</span><span class="n">Cerebro</span><span class="p">()</span>
 <span class="n">MyCerebro</span><span class="o">.</span><span class="n">addstrategy</span><span class="p">(</span><span class="n">BTgymStrategy</span><span class="p">,</span>
@@ -276,11 +281,8 @@ <h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this
 <span class="n">MyDataset</span> <span class="o">=</span> <span class="n">BTgymDataset</span><span class="p">(</span><span class="n">filename</span><span class="o">=</span><span class="s1">&#39;../examples/data/DAT_ASCII_EURUSD_M1_2016.csv&#39;</span><span class="p">,</span>
                          <span class="n">start_weekdays</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">],</span>
                          <span class="n">start_00</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
-                         <span class="n">episode_len_days</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
-                         <span class="n">episode_len_hours</span><span class="o">=</span><span class="mi">23</span><span class="p">,</span>
-                         <span class="n">episode_len_minutes</span><span class="o">=</span><span class="mi">55</span><span class="p">,</span>
-                         <span class="n">time_gap_days</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
-                         <span class="n">time_gap_hours</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
+                         <span class="n">episode_duration</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;days&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">&#39;hours&#39;</span><span class="p">:</span> <span class="mi">23</span><span class="p">,</span> <span class="s1">&#39;minutes&#39;</span><span class="p">:</span> <span class="mi">55</span><span class="p">},</span>
+                         <span class="n">time_gap</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;hours&#39;</span><span class="p">:</span> <span class="mi">5</span><span class="p">},</span>
                          <span class="p">)</span>
 
 <span class="n">MyEnvironment</span> <span class="o">=</span> <span class="n">BTgymEnv</span><span class="p">(</span><span class="n">dataset</span><span class="o">=</span><span class="n">MyDataset</span><span class="p">,</span>