Skip to content

Commit c912125

Browse files
committed
final
1 parent 70fca83 commit c912125

13 files changed

Lines changed: 27 additions & 22 deletions

File tree

docs/source/reference/data_specs.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. currentmodule:: torchrl.data
22

3+
.. _ref_specs:
4+
35
TensorSpec System
46
=================
57

docs/source/reference/data_storage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. currentmodule:: torchrl.data.replay_buffers
22

3+
.. _checkpoint-rb:
4+
35
Storage Backends
46
================
57

docs/source/reference/llms.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ such as :class:`~torchrl.envs.llm.ChatEnv`.
204204
An example of a tool transform is the :class:`~torchrl.envs.llm.transforms.PythonInterpreter` transform, which is used
205205
to execute Python code in the context of the LLM. The PythonInterpreter can optionally use a shared
206206
:class:`~torchrl.envs.llm.transforms.PythonExecutorService` for efficient resource usage across multiple environments.
207-
See :ref:`ref_services` for more details on the service registry system.
207+
See :doc:`services` for more details on the service registry system.
208208

209209
>>> from torchrl.envs.llm.transforms import PythonInterpreter
210210
>>> from torchrl.envs.llm import ChatEnv

docs/source/reference/modules.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ torchrl.modules package
44
=======================
55

66
.. _ref_modules:
7+
.. _tdmodules:
78

89
TorchRL offers a comprehensive collection of RL-specific neural network modules built on top of
910
:class:`tensordict.nn.TensorDictModule`. These modules are designed to work seamlessly with

docs/source/reference/services.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -590,7 +590,7 @@ For complete examples, see:
590590
See Also
591591
--------
592592

593-
- :ref:`ref_llms` - LLM API documentation
593+
- :doc:`llms` - LLM API documentation
594594
- :ref:`ref_collectors` - Collector documentation
595595
- `Ray Documentation <https://docs.ray.io/>`_ - Ray distributed framework documentation
596596

knowledge_base/HABITAT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Instructions can be found on [habitat github repo](https://github.com/facebookre
2929

3030
### Installing TorchRL
3131

32-
Follow the instructions on the [README.md](../README.md).
32+
Follow the instructions on the [README.md](README.md).
3333

3434
### Using Habitat
3535
To get the list of available Habitat envs, simply run the following command:

knowledge_base/MUJOCO_INSTALLATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ issues when running `import mujoco_py` and some troubleshooting for each of them
176176
```
177177
178178
_Solution_: Link conda to the right `libOpenGL.so` file (replace `/path/to/conda` and `mujoco_env` with the proper paths and names):
179-
```shelf
179+
```shell
180180
conda install -y -c conda-forge libglvnd-glx-cos7-x86_64 --force-reinstall
181181
conda install -y -c conda-forge xvfbwrapper --force-reinstall
182182
conda env config vars set LD_PRELOAD=/path/to/conda/envs/mujoco_env/x86_64-conda-linux-gnu/sysroot/usr/lib64/libGLdispatch.so.0

knowledge_base/PRO-TIPS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Errors to look for that may be related to this misconception are the following:
102102

103103
## Common bugs
104104
- For bugs related to mujoco (incl. DeepMind Control suite and other libraries),
105-
refer to the [MUJOCO_INSTALLATION](MUJOCO_INSTALLATION.md) file.
105+
refer to the [MUJOCO_INSTALLATION](./MUJOCO_INSTALLATION.md) file.
106106
- `ValueError: bad value(s) in fds_to_keep`: this can have multiple reasons. One that is common in torchrl
107107
is that you are trying to send a tensor across processes that is a view of another tensor.
108108
For instance, when sending the tensor `b = tensor.expand(new_shape)` across processes, the reference to the original

torchrl/collectors/weight_update.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -360,9 +360,9 @@ class VanillaWeightUpdater(WeightUpdaterBase):
360360
361361
Keyword Args:
362362
weight_getter (Callable[[], TensorDictBase], optional): a callable that returns the weights from the server.
363-
If not provided, the weights must be passed to :meth:`~.update_weights` directly.
363+
If not provided, the weights must be passed to ``push_weights`` directly.
364364
policy_weights (TensorDictBase): a TensorDictBase containing the policy weights to be updated
365-
in-place.
365+
in-place. Use ``push_weights`` to update the weights.
366366
"""
367367

368368
@classmethod

torchrl/envs/llm/transforms/browser.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ class BrowserTransform(SimpleToolTransform):
106106
This transform allows LLM agents to interact with web pages through a browser,
107107
supporting actions like navigation, clicking, typing, and extracting content.
108108
109-
For a complete example of how to use this transform, see the :ref:`llm_tools` tutorial.
109+
For a complete example of how to use this transform, see the LLM Tools tutorial in the documentation.
110110
111111
Args:
112112
allowed_domains (list[str], optional): List of allowed domains. If None, all domains are allowed.

0 commit comments

Comments
 (0)