Skip to content

Commit 02d25e1

Browse files
committed
Update documentation for MapFunction and VectorFunction
1 parent d730666 commit 02d25e1

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/howto/observation-functions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ explicitly pass ``None`` to the environment constructor.
5757
5858
Multiple Observation Functions
5959
------------------------------
60-
To use multiple observation functions, wrap them in a ``tuple`` or ``dict``.
60+
To use multiple observation functions, wrap them in a ``list`` or ``dict``.
6161

6262
.. code-block:: python
6363
@@ -67,7 +67,7 @@ To use multiple observation functions, wrap them in a ``tuple`` or ``dict``.
6767
>>> env = ecole.environment.branching(observation_function=obs_func)
6868
>>> obs, _, _, _ = env.reset("path/to/problem")
6969
>>> obs
70-
(ecole.observation.NodeBipartiteObs(), None)
70+
[ecole.observation.NodeBipartiteObs(), None]
7171
7272
Similarily with a tuple
7373

docs/reference/observations.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ Nothing
3535
^^^^^^^
3636
.. autoclass:: ecole.observation.Nothing
3737

38-
Tuple of Observations
39-
^^^^^^^^^^^^^^^^^^^^^
40-
.. autoclass:: ecole.observation.TupleFunction
38+
List of Observations
39+
^^^^^^^^^^^^^^^^^^^^
40+
.. autoclass:: ecole.observation.VectorFunction
4141

4242
Dictionnary of Observations
4343
^^^^^^^^^^^^^^^^^^^^^^^^^^^
44-
.. autoclass:: ecole.observation.DictFunction
44+
.. autoclass:: ecole.observation.MapFunction

0 commit comments

Comments
 (0)