Skip to content

Commit 5053d42

Browse files
[doc, data] fix: resolve broken documentation hyperlinks (verl-project#4970)
### What does this PR do? Fix gsm8k datasets and tensordict hyperlink 404 not found. ### Checklist Before Starting - [x] Search for similar PRs. Paste at least one query link here: ... - [x] Format the PR title as `[{modules}] {type}: {description}` (This will be checked by the CI) - `{modules}` include `fsdp`, `megatron`, `veomni`, `sglang`, `vllm`, `rollout`, `trainer`, `ci`, `training_utils`, `recipe`, `hardware`, `deployment`, `ray`, `worker`, `single_controller`, `misc`, `perf`, `model`, `algo`, `env`, `tool`, `ckpt`, `doc`, `data`, `cfg`, `reward` - If this PR involves multiple modules, separate them with `,` like `[megatron, fsdp, doc]` - `{type}` is in `feat`, `fix`, `refactor`, `chore`, `test` - If this PR breaks any API (CLI arguments, config, function signature, etc.), add `[BREAKING]` to the beginning of the title. - Example: `[BREAKING][fsdp, megatron] feat: dynamic batching` ### Test N/A - This is a comment-only change ### API and Usage Example N/A - No API changes. ```python # Add code snippet or script demonstrating how to use this ``` ### Design & Code Changes - Changed 'https://huggingface.co/datasets/gsm8k' to 'https://huggingface.co/datasets/openai/gsm8k' - Changed 'https://pytorch.org/tensordict/tutorials/data_fashion' to 'https://pytorch.org/tensordict/stable/tutorials/data_fashion' - Changed 'https://pytorch.org/tensordict/overview.html' to 'https://pytorch.org/tensordict/stable/overview.html' ### Checklist Before Submitting > [!IMPORTANT] > Please check all the following items before requesting a review, otherwise the reviewer might deprioritize this PR for review. - [x] Read the [Contribute Guide](https://github.com/volcengine/verl/blob/main/CONTRIBUTING.md). - [x] Apply [pre-commit checks](https://github.com/volcengine/verl/blob/main/CONTRIBUTING.md#code-linting-and-formatting): `pre-commit install && pre-commit run --all-files --show-diff-on-failure --color=always` - [ ] Add / Update [the documentation](https://github.com/volcengine/verl/tree/main/docs). - [ ] Add unit or end-to-end test(s) to [the CI workflow](https://github.com/volcengine/verl/tree/main/.github/workflows) to cover all the code. If not feasible, explain why: ... - [ ] Once your PR is ready for CI, send a message in [the `ci-request` channel](https://verl-project.slack.com/archives/C091TCESWB1) in [the `verl` Slack workspace](https://join.slack.com/t/verl-project/shared_invite/zt-3855yhg8g-CTkqXu~hKojPCmo7k_yXTQ). (If not accessible, please try [the Feishu group (飞书群)](https://applink.larkoffice.com/client/chat/chatter/add_by_link?link_token=772jd4f1-cd91-441e-a820-498c6614126a).) - [ ] If your PR is related to the `recipe` submodule, please also update the reference to the submodule commit via `git submodule update --remote` or `cd recipe && git pull origin main`.
1 parent 75d8b00 commit 5053d42

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

docs/api/data.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ One can also index a tensordict along its batch_size. The contents of the Tensor
5151
5252
For more about :class:`tensordict.TensorDict` usage, see the official tensordict_ documentation.
5353

54-
.. _tensordict: https://pytorch.org/tensordict/overview.html
54+
.. _tensordict: https://pytorch.org/tensordict/stable/overview.html
5555

5656

5757
Core APIs

docs/examples/gsm8k_example.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In this example, we train an LLM to tackle the GSM8k task.
1010

1111
Paper: https://arxiv.org/pdf/2110.14168
1212

13-
Dataset: https://huggingface.co/datasets/gsm8k
13+
Dataset: https://huggingface.co/datasets/openai/gsm8k
1414

1515
Note that the original paper mainly focuses on training a verifier (a
1616
reward model) to solve math problems via Best-of-N sampling. In this

docs/start/quickstart.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Post-train a LLM using GSM8K dataset.
99
Introduction
1010
------------
1111

12-
.. _hf_dataset_gsm8k: https://huggingface.co/datasets/gsm8k
12+
.. _hf_dataset_gsm8k: https://huggingface.co/datasets/openai/gsm8k
1313

1414
In this example, we train an LLM to tackle the `GSM8k <hf_dataset_gsm8k>`_ task with function-based rewards. [1]_
1515

verl/protocol.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -810,7 +810,7 @@ def union(self, other: "DataProto") -> "DataProto":
810810

811811
def make_iterator(self, mini_batch_size, epochs, seed=None, dataloader_kwargs=None):
812812
r"""Make an iterator from the DataProto. This is built upon that TensorDict can be used as a normal Pytorch
813-
dataset. See https://pytorch.org/tensordict/tutorials/data_fashion for more details.
813+
dataset. See https://pytorch.org/tensordict/stable/tutorials/data_fashion for more details.
814814
815815
816816
Args:

0 commit comments

Comments
 (0)