torchtune icon indicating copy to clipboard operation
torchtune copied to clipboard

Add example recipes for CPU and XPU

Open zxd1997066 opened this issue 1 year ago • 4 comments

Context

What is the purpose of this PR? Is it to

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

Please link to any issues this PR addresses.

We verified LoRA single device finetuning for below models on both CPU and XPU. Add example recipes for them to show the support of CPU and XPU. Firstly, we added example recipes for Llama3.2 3B LoRA single device finetuning. If it is OK, we can add example recipes for remaining models.

Model Sizes
Llama3.2-Vision 11B
Llama3.2 3B
Llama3.1 8B
Llama3 8B
Llama2 7B
Code-Llama2 7B
Mistral 7B
Gemma 7B
Microsoft Phi3 Mini
Qwen2 1.5B

Changelog

What are the changes made in this PR?

  • Add example recipes for CPU and XPU, and register them in torchtune/_recipe_registry.py

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
  • [X] 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

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

zxd1997066 avatar Dec 16 '24 02:12 zxd1997066

:link: Helpful Links

:test_tube: See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/2160

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

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

pytorch-bot[bot] avatar Dec 16 '24 02:12 pytorch-bot[bot]

Hey @zxd1997066. Thanks so much for opening this. It looks like the main addition in these configs is updating output_dir and device. I wonder if it might be overkill to to add entire configs just to change the device arg, particularly if it's not as easy to maintain these configs without access to XPU-enabled hardware. What are your thoughts?

In the spirit of this PR, I think we can do more to surface our multi-device support. Perhaps we could add a section to our README or our docs to show how you can use a CLI override to easily change the device (e.g. device=xpu)?

SalmanMohammadi avatar Dec 16 '24 10:12 SalmanMohammadi

Hey @zxd1997066. Thanks so much for opening this. It looks like the main addition in these configs is updating output_dir and device. I wonder if it might be overkill to to add entire configs just to change the device arg, particularly if it's not as easy to maintain these configs without access to XPU-enabled hardware. What are your thoughts?

In the spirit of this PR, I think we can do more to surface our multi-device support. Perhaps we could add a section to our README or our docs to show how you can use a CLI override to easily change the device (e.g. device=xpu)?

Seconded! We want to be careful about how many recipes we maintain in our core library. I'd love if you wanted to add a comment to the configs (that you've tested for), similar to how we outline options for our memory optimization techniques. E.g.

device: cuda  # can also use xpu, npu, or cpu

And then we can add a highlight to our documentation, as well. How does this sound?

joecummings avatar Dec 16 '24 13:12 joecummings

Hi @SalmanMohammadi @joecummings , thanks for the suggestions, they sound good, and we will take a look at them.

zxd1997066 avatar Dec 17 '24 02:12 zxd1997066

Closing as there has been no activity for awhile.

joecummings avatar May 08 '25 16:05 joecummings