Skip to content

[feature] Add debug_dataloader_samples utility to preview decoded dataloader samples (#184) #368

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

Open
wants to merge 11 commits into
base: dev
Choose a base branch
from

Conversation

garongkim
Copy link

What does this PR do?

This PR adds a utility function debug_dataloader_samples() under utils/debug_utils.py.

It allows users to preview a few decoded examples from the first batch of the training DataLoader, which can help ensure that tokenization is working correctly before launching a long training run.
This debug utility addresses #184.

Although another contributor expressed interest in the issue, no progress or maintainer feedback has occurred in the last 3 weeks.
As this feature is simple but useful, I decided to implement and contribute it directly.

How to use

This utility can be optionally called from run_train.py or any other training script to inspect tokenized input samples before training.
Here is an example snippet:

python
from nanotron.utils.debug_utils import debug_dataloader_samples

debug_dataloader_samples(train_dataloader, tokenizer, num_samples=3)

Notes

To avoid a circular import issue between utils.py and distributed.py,
this function is placed in a new module debug_utils.py instead of the main utils.py.

Logging is used instead of print() to remain consistent with Nanotron’s logging system.

This PR replaces a previous one that included unnecessary commits. This version is rebased and clean for easier review.

Fixes #184

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guidelines?
  • Did you write any new necessary tests?
  • Did you log the throughput and loss you get to ensure the PR works as expected in actual training?
  • Did you log the memory usage? you can use this tool to understand the memory usage breakdown in nanotron.
  • If you modified anything related to checkpoints, did you verify that saving and reloading checkpoints still works correctly?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

NouamaneTazi and others added 5 commits April 14, 2025 16:17
…face#353)

* can only merge to main from dev

* Fix UnBoundLocalError in `clm_collator.py` (huggingface#339)

* Update clm_collator.py

* can only merge to main from dev (huggingface#348)

---------

Co-authored-by: Nouamane Tazi <nouamane@huggingface.co>

* fix init and init scaling factor and run evals in background (huggingface#349)

* InitScalingMethod

* InitScalingMethod

* run evals in background (huggingface#352)

* eval

* try adding lightevalrunner to trainer

* amend

* amend

* amend

* amend

* amend

* amend

* .

* amend

* amend

* .

* qos to low

* add nanotron_path

* some fix: logs, and config

* cp instead of sync

* eval_interval

* serialize sanity checks

* add output dir and s3_save path in the config

* fix s3 only if define

* fixes

---------

Co-authored-by: elie <97572401+eliebak@users.noreply.github.com>
Co-authored-by: “eliebak” <elie.bakouch@huggingface.co>

---------

Co-authored-by: elie <97572401+eliebak@users.noreply.github.com>
Co-authored-by: “eliebak” <elie.bakouch@huggingface.co>

---------

Co-authored-by: Connector Switch <c8ef@outlook.com>
Co-authored-by: elie <97572401+eliebak@users.noreply.github.com>
Co-authored-by: “eliebak” <elie.bakouch@huggingface.co>
* deepwiki

* Update README.md
grewalsk and others added 6 commits June 2, 2025 20:25
huggingface#346)

* [Feature] Implement CUDA event-based timing for improved GPU performance measurement

* can only merge to main from dev (huggingface#348)

* Fix timer decorator logic: Support both CPU and CUDA timers and update docs

* Fix timer decorator logic: support both CPU and CUDA; update docs

---------

Co-authored-by: Kabir Grewal <kabirgrewal@Kabirs-MacBook-Pro-5.local>
Co-authored-by: Nouamane Tazi <nouamane@huggingface.co>
Co-authored-by: Kabir Grewal <kabirgrewal@kabirs-mbp-5.wireless-1x.unc.edu>
* can only merge to main from dev (huggingface#348)

* move moe from qwen modeling to src/nn

* add groupedmlp

* add token permute and unpermute

* fix num_tokens_per_expert counting < num_experts

* fix init and init scaling factor and run evals in background (huggingface#353)

* can only merge to main from dev

* Fix UnBoundLocalError in `clm_collator.py` (huggingface#339)

* Update clm_collator.py

* can only merge to main from dev (huggingface#348)

---------

Co-authored-by: Nouamane Tazi <nouamane@huggingface.co>

* fix init and init scaling factor and run evals in background (huggingface#349)

* InitScalingMethod

* InitScalingMethod

* run evals in background (huggingface#352)

* eval

* try adding lightevalrunner to trainer

* amend

* amend

* amend

* amend

* amend

* amend

* .

* amend

* amend

* .

* qos to low

* add nanotron_path

* some fix: logs, and config

* cp instead of sync

* eval_interval

* serialize sanity checks

* add output dir and s3_save path in the config

* fix s3 only if define

* fixes

---------

Co-authored-by: elie <97572401+eliebak@users.noreply.github.com>
Co-authored-by: “eliebak” <elie.bakouch@huggingface.co>

---------

Co-authored-by: elie <97572401+eliebak@users.noreply.github.com>
Co-authored-by: “eliebak” <elie.bakouch@huggingface.co>

---------

Co-authored-by: Connector Switch <c8ef@outlook.com>
Co-authored-by: elie <97572401+eliebak@users.noreply.github.com>
Co-authored-by: “eliebak” <elie.bakouch@huggingface.co>

* inference qwen moe seems to work

inference seems good rn

* update readme

* fix router's weight initialization and wrong hidden size for non-moe mlp in qwen

* add source for router weight and router logits in float32

* fixes

* .

* .

* add parametrize grouped mlp in column and row linear

* add logging per-param grad norm

* fix conversation fail due to buffer on cpu

* config_qwen

* .

* .

* fix moe convert config

---------

Co-authored-by: Nouamane Tazi <nouamane@huggingface.co>
Co-authored-by: Connector Switch <c8ef@outlook.com>
Co-authored-by: elie <97572401+eliebak@users.noreply.github.com>
Co-authored-by: “eliebak” <elie.bakouch@huggingface.co>
Co-authored-by: zzhhjjj <z785566960@gmail.com>
Co-authored-by: nouamanetazi <nouamane98@gmail.com>
* InitScalingMethod

* InitScalingMethod

* eval

* try adding lightevalrunner to trainer

* amend

* amend

* amend

* amend

* amend

* amend

* .

* amend

* amend

* .

* qos to low

* add nanotron_path

* some fix: logs, and config

* cp instead of sync

* eval_interval

* serialize sanity checks

* add output dir and s3_save path in the config

* fix s3 only if define

* fixes

* add requeue

* add wandb with lighteval and fix eval interval

* fix this little space :(

* folder_path should always have s3 when using s3 (fix consumed tokens issue)

* config qwen

* .

---------

Co-authored-by: elie <97572401+eliebak@users.noreply.github.com>
Co-authored-by: “eliebak” <elie.bakouch@huggingface.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants