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

Update the e2e flow tutorial to fix errors of generate #2251

Merged
merged 2 commits into from
Jan 23, 2025

Conversation

iseeyuan
Copy link
Contributor

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)

Please link to any issues this PR addresses.

Changelog

What are the changes made in this PR?
When running the tutorial as is, there's error message:

ValueError: The output directory cannot be the same as or a subdirectory of the checkpoint directory. Found ckpt_dir=PosixPath('/tmp/torchtune/llama3_2_3B/lora_single_device/epoch_0') and out_dir=PosixPath('/tmp/torchtune/llama3_2_3B/lora_single_device/epoch_0')
  • The fix is to add a specific checkpoint_dir and make it different from the output_dir.

Then I saw the second error:

...
  File "/home/myuan/src/torchtune/recipes/generate.py", line 113, in convert_prompt_to_tokens
    Message(role="user", content=prompt["user"]),
TypeError: string indices must be integers
  • The fix is to remove the prompt option from run. It's redundant with the prompt in the .yaml file anyway.

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.)

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

Copy link

pytorch-bot bot commented Jan 10, 2025

🔗 Helpful Links

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

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

⏳ No Failures, 6 Pending

As of commit 5d1280e with merge base c152248 (image):
💚 Looks good so far! There are no failures yet. 💚

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

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 10, 2025
Copy link
Contributor

@RdoubleA RdoubleA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! just one small comment

@@ -330,7 +332,7 @@ these parameters.

.. code-block:: text

$ tune run generate --config ./custom_generation_config.yaml prompt="tell me a joke. "
$ tune run generate --config ./custom_generation_config.yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you try running this?
tune run generate --config ./custom_generation_config.yaml prompt.user="Tell me a joke. "

if that works fine, would prefer including this as an example just to be explicit

@RdoubleA RdoubleA mentioned this pull request Jan 21, 2025
@RdoubleA RdoubleA merged commit 90fd2d3 into pytorch:main Jan 23, 2025
17 checks passed
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 23.95%. Comparing base (f47f633) to head (5d1280e).
Report is 20 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2251      +/-   ##
==========================================
- Coverage   24.00%   23.95%   -0.06%     
==========================================
  Files         357      358       +1     
  Lines       21094    21205     +111     
==========================================
+ Hits         5064     5080      +16     
- Misses      16030    16125      +95     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants