Make q optional in sample

[joecummings]

Context

What is the purpose of this PR? Is it to

• add a new feature
• fix a bug
• update tests and/or documentation
• other (please add here)

User should not have to specify q in order to use the sample method. Therefore, we can provide the default.

TODO: Look into whether setting the RNG is actually necessary or if a global Generator works fine, too.

Changelog

• Set default for q

Test plan

Please make sure to do each of the following if applicable to your PR. If you're unsure about any one of these just ask and we will happily help. We also have a contributing page for some guidance on contributing.

• run pre-commit hooks and linters (make sure you've first installed via pre-commit install)
• add unit tests for any new functionality
• update docstrings for any new or updated methods or classes
• run unit tests via pytest tests
• run recipe tests via pytest tests -m integration_test
• manually run any new or modified recipes with sufficient proof of correctness
• include relevant commands and any other artifacts in this summary (pastes of loss curves, eval results, etc.)

>>> from torchtune.generation import sample
>>> import torch
>>> compiled_sample = torch.compile(sample, fullgraph=True, backend="aot_eager")
>>> logits = torch.empty(3, 3).uniform_(0, 1)
>>> compiled_sample(logits)
tensor([[1],
        [2],
        [0]], dtype=torch.int32)
>>> sample(logits)
tensor([[1],
        [2],
        [0]], dtype=torch.int32)

UX

If your function changed a public API, please add a dummy example of what the user experience will look like when calling it.
Here is a docstring example
and a tutorial example

• I did not change any public API
• I have added an example to docs or docstrings

[pytorch-bot]

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/1637

• 📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit ba968d2 with merge base 9f329a2 ():
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

[pbontrager]

Please test this with all recipes that explicitly use "q". Otherwise looks good.

[pbontrager]

Can we remove q here all together?