Merge pull request #17 from BDonnot/gym_integration

refactoring for better gym integration (to be done later)

CHANGELOG.rst

@@ -1,6 +1,43 @@
 Change Log
 =============
 
+[0.4.2] - 2020-01-08
+--------------------
+- [FIXED] gym compatibility issue for environment
+- [FIXED] checking key-word arguments in "make" function: if an invalid argument is provided,
+  it now raises an error.
+- [UPDATED] multiple random generator streams for observations
+- [UPDATED] Refactoring of the Action and Observation Space. They now both ineherit from "Space"
+- [BREAKING] previous saved Action Spaces and Observation Spaces (as dictionnary) are no more compatible
+- [BREAKING] renaming of attributes describing the powergrid accross classes for better consistency:
+
+====================  =======================  =======================
+Class Name            Old Attribute Name       New Attribute Name
+====================  =======================  =======================
+Backend               n_lines                  n_line
+Backend               n_generators             n_gen
+Backend               n_loads                  n_load
+Backend               n_substations            n_sub
+Backend               subs_elements            sub_info
+Backend               name_loads               name_load
+Backend               name_prods               name_gen
+Backend               name_lines               name_line
+Backend               name_subs                name_sub
+Backend               lines_or_to_subid        line_or_to_subid
+Backend               lines_ex_to_subid        line_ex_to_subid
+Backend               lines_or_to_sub_pos      line_or_to_sub_pos
+Backend               lines_ex_to_sub_pos      line_ex_to_sub_pos
+Backend               lines_or_pos_topo_vect   line_or_pos_topo_vect
+Backend               lines_ex_pos_topo_vect   lines_ex_pos_topo_vect
+Action / Observation  _lines_or_to_subid       line_or_to_subid
+Action / Observation  _lines_ex_to_subid       line_ex_to_subid
+Action / Observation  _lines_or_to_sub_pos     line_or_to_sub_pos
+Action / Observation  _lines_ex_to_sub_pos     line_ex_to_sub_pos
+Action / Observation  _lines_or_pos_topo_vect  line_or_pos_topo_vect
+Action / Observation  _lines_ex_pos_topo_vect  lines_ex_pos_topo_vect
+GridValue             n_lines                  n_line
+====================  =======================  =======================
+
 [0.4.1] - 2019-12-17
 --------------------
 - [FIXED] Bug#14 : Nan in the observation space after switching one powerline [PandaPowerBackend]

docs/conf.py

@@ -22,7 +22,7 @@
 author = 'Benjamin Donnot'
 
 # The full version, including alpha/beta/rc tags
-release = '0.4.1'
+release = '0.4.2'
 version = '0.4'
 
 

docs/index.rst

@@ -3,10 +3,10 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Grid2Op's documentation!
-===================================
+Welcome to Grid2Op's technical documentation!
+=============================================
 
-Grdi2Op is a pythonic, easy to use framework to be able to develop, train or evaluate performances of "agent" or
+Grdi2Op is a pythonic, easy to use framework, to be able to develop, train or evaluate performances of "agent" or
 "controler" that acts on a power grid in  different ways.
 
 It is modular and can be use to train reinforcement learning agent or to assess the performance of optimal control
@@ -53,6 +53,7 @@ Technical Documentation
    parameters
    reward
    runner
+   space
 
 Main Exceptions
 -----------------------

docs/space.rst

@@ -0,0 +1,9 @@
+Space
+===================================
+.. automodule:: grid2op.Space
+    :members:
+    :show-inheritance:
+    :special-members:
+
+.. include:: final.rst
+