Skip to content

Commit 21aed4f

Browse files
committed
Documentation cleanup
1 parent 1a7276b commit 21aed4f

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/discussion/seeding.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ One such aspect is the solver randomness, which is controlled by its random seed
88

99
This means that, by default, Ecole environment will generate different episodes (and in
1010
particular different initial states) after each new call to
11-
:py:meth:`~ecole.environment.EnvironmentComposer.reset`.
11+
:py:meth:`~ecole.environment.Environment.reset`.
1212
To do so, the environment keeps a :py:class:`~ecole.RandomGenerator` (random state)
1313
between episodes, and start a new episode by calling
1414
:py:meth:`~ecole.typing.Dynamics.set_dynamics_random_state` on the underlying

docs/howto/create-environments.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,13 +117,13 @@ To do so, we will take parameters in the constructor.
117117
__Dynamics__ = SimpleBranchingDynamics
118118

119119

120-
The constructor arguments are forwarded from the :py:meth:`~ecole.environment.EnvironmentComposer.__init__` constructor:
120+
The constructor arguments are forwarded from the :py:meth:`~ecole.environment.Environment.__init__` constructor:
121121

122122
.. testcode::
123123
:skipif: pyscipopt is None
124124

125125
env = SimpleBranching(observation_function=None, disable_cuts=False)
126126

127-
Similarily, extra arguments given to the environemnt :py:meth:`~ecole.environment.EnvironmentComposer.reset` and
128-
:py:meth:`~ecole.environment.EnvironmentComposer.step` are forwarded to the associated
127+
Similarily, extra arguments given to the environemnt :py:meth:`~ecole.environment.Environment.reset` and
128+
:py:meth:`~ecole.environment.Environment.step` are forwarded to the associated
129129
:py:class:`~ecole.typing.Dynamics` methods.

docs/howto/instances.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ With an Environment
5959
-------------------
6060
The instance objects generated by :py:class:`~ecole.typing.InstanceGenerator`s,
6161
of type :py:class:`ecole.scip.Model`, can be passed directly to an environment's
62-
:py:meth:`~ecole.environment.EnvironmentComposer.reset` method.
62+
:py:meth:`~ecole.environment.Environment.reset` method.
6363

6464
A typical example training over 1000 instances/episodes would look like:
6565

@@ -78,7 +78,7 @@ A typical example training over 1000 instances/episodes would look like:
7878

7979
.. note::
8080
The generated instance objects can be, in principle, modified between their generation and their usage in an environment
81-
:py:meth:`~ecole.environment.EnvironmentComposer.reset` method. To keep code clean, however, we recommend that such modifications
81+
:py:meth:`~ecole.environment.Environment.reset` method. To keep code clean, however, we recommend that such modifications
8282
be wrapped in a custom environment class. Details about custom environments :ref:`can be found here<create-new-environment>`.
8383

8484

0 commit comments

Comments
 (0)