Skip to content

Commit

Permalink
adressing issue rte-france#158 by updating the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
BDonnot committed Nov 15, 2020
1 parent f83aacd commit 3856f2e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 20 deletions.
22 changes: 5 additions & 17 deletions grid2op/Observation/BaseObservation.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,19 @@ class BaseObservation(GridObjects):
The current year
month: ``int``
The current month (0 = january, 11 = december)
The current month (1 = january, 12 = december)
day: ``int``
The current day of the month
The current day of the month (1 = first day of the month)
hour_of_day: ``int``
The current hour of the day
The current hour of the day (from O to 23)
minute_of_hour: ``int``
The current minute of the current hour
The current minute of the current hour (from 0 to 59)
day_of_week: ``int``
The current day of the week. Monday = 0, Sunday = 6
The current day of the week (monday = 0 and sunday = 6)
prod_p: :class:`numpy.ndarray`, dtype:float
The active production value of each generator (expressed in MW).
Expand Down Expand Up @@ -95,18 +95,6 @@ class BaseObservation(GridObjects):
The capacity of each powerline. It is defined at the observed current flow divided by the thermal limit of each
powerline (no unit)
connectivity_matrix_: :class:`numpy.ndarray`, dtype:float
The connectivityt matrix (if computed, or None) see definition of :func:`connectivity_matrix` for
more information
bus_connectivity_matrix_: :class:`numpy.ndarray`, dtype:float
The `bus_connectivity_matrix_` matrix (if computed, or None) see definition of
:func:`BaseObservation.bus_connectivity_matrix` for more information
vectorized: :class:`numpy.ndarray`, dtype:float
The vector representation of this BaseObservation (if computed, or None) see definition of
:func:`to_vect` for more information.
topo_vect: :class:`numpy.ndarray`, dtype:int
For each object (load, generator, ends of a powerline) it gives on which bus this object is connected
in its substation. See :func:`grid2op.Backend.Backend.get_topo_vect` for more information.
Expand Down
5 changes: 2 additions & 3 deletions grid2op/Observation/CompleteObservation.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,8 @@ class CompleteObservation(BaseObservation):
Attributes
----------
dictionnarized: ``dict``
The representation of the action in a form of a dictionnary. See the definition of
:func:`CompleteObservation.to_dict` for a description of this dictionnary.
attr_list_vect: ``list``
List of elements that represent the observation when converted as a vector.
"""
def __init__(self,
Expand Down

0 comments on commit 3856f2e

Please sign in to comment.