Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Toni-SM committed Sep 11, 2024
1 parent 9ba2771 commit 50d6dcd
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/source/api/utils/model_instantiators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Inputs
^^^^^^

Inputs can be specified using tokens or previously defined container outputs (by container name).
Certain operations could be specified on them, including indexing (by a range of numbers in sequences, by key in dictionaries) and slicing
Certain operations could be specified on them, including indexing and slicing

.. hint::

Expand All @@ -84,9 +84,6 @@ Supported operations:

* - Operations
- Example
* - Dictionary indexing
|br| E.g.: :py:class:`gymnasium.spaces.Dict`
- ``STATES["camera"]``
* - Tensor/array indexing and slicing
|br| E.g.: :py:class:`gymnasium.spaces.Box`
- ``STATES[:, 0]``
Expand Down Expand Up @@ -285,6 +282,12 @@ conv2d

Apply a 2D convolution (:py:class:`torch.nn.Conv2d` in PyTorch, :py:class:`flax.linen.Conv` in JAX)

.. warning::

* PyTorch :py:class:`torch.nn.Conv2d` expects the input to be in the form NCHW (*N*: batch, *C*: channels, *H*: height, *W*: width).
A permutation operation may be necessary to modify the dimensions of a batch of images which are typically NHWC.
* JAX :py:class:`flax.linen.Conv` expects the input to be in the form NHWC (the typical dimensions of a batch of images).

.. note::

If the PyTorch's ``in_channels`` parameter is not specified it will be inferred by using the :py:class:`torch.nn.LazyConv2d` module
Expand Down

0 comments on commit 50d6dcd

Please sign in to comment.