Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Refactor] Rename specs to simpler names #2368

Merged
merged 23 commits into from
Aug 7, 2024
Merged
Prev Previous commit
Next Next commit
amend
  • Loading branch information
vmoens committed Aug 6, 2024
commit cfb95ed00c52ea7172e303b91b8e9ee3682585bf
26 changes: 17 additions & 9 deletions docs/source/reference/data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -889,15 +889,23 @@ function.

Specs fall in two main categories, numerical and categorical.

.. table:: TensorSpec subclasses.

+-------------------------------------------------------------------------------+------------------------------------------------------------------+
| Numerical | Categorical | |
+=====================================+=========================================+========+=============+=============+==================+==========+
| Bounded | Unbounded | OneHot | MultiOneHot | Categorical | MultiCategorical | Binary |
+-----------------+-------------------+-------------------+---------------------+ | | | | |
| BoundedDiscrete | BoundedContinuous | UnboundedDiscrete | UnboundedContinuous | | | | | |
+-----------------+-------------------+-------------------+---------------------+--------+-------------+-------------+------------------+----------+
.. table:: Numerical TensorSpec subclasses.

+-------------------------------------------------------------------------------+
| Numerical |
+=====================================+=========================================+
| Bounded | Unbounded |
+-----------------+-------------------+-------------------+---------------------+
| BoundedDiscrete | BoundedContinuous | UnboundedDiscrete | UnboundedContinuous |
+-----------------+-------------------+-------------------+---------------------+

.. table:: Categorical TensorSpec subclasses.

+------------------------------------------------------------------+
| Categorical | |
+========+=============+=============+==================+==========+
| OneHot | MultiOneHot | Categorical | MultiCategorical | Binary |
+--------+-------------+-------------+------------------+----------+

Whenever a :class:`~torchrl.data.Bounded` instance is created, its domain (defined either implicitly by its dtype or
explicitly by the `"domain"` keyword argument) will determine if the instantiated class will be of :class:`~torchrl.data.BoundedContinuous`
Expand Down
Loading