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

Add system prompt #1366

Merged
merged 7 commits into from
Aug 20, 2024
Merged

Add system prompt #1366

merged 7 commits into from
Aug 20, 2024

Conversation

RdoubleA
Copy link
Contributor

@RdoubleA RdoubleA commented Aug 19, 2024

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)

Enable adding an optional system prompt in our built-in message transforms. Expose this parameter in our dataset builders. Any user dataset that uses our common message transforms can leverage this feature.

Addresses #1328

Test plan

Please make sure to do each of the following if applicable to your PR. (If you're not sure 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.
Example of docstring:


Example in our docs: https://pytorch.org/torchtune/main/tutorials/qat_finetune.html#applying-qat-to-llama3-models

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

Copy link

pytorch-bot bot commented Aug 19, 2024

🔗 Helpful Links

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

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

✅ No Failures

As of commit 29cdf96 with merge base 4ae950b (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 Aug 19, 2024
self,
train_on_input: bool = False,
column_map: Optional[Dict[str, str]] = None,
system_prompt: Optional[str] = None,
Copy link
Contributor

Choose a reason for hiding this comment

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

Need some way to convey that this will either add or override the given system prompt:

new_system_prompt?

@@ -19,6 +19,7 @@ def grammar_dataset(
source: str = "liweili/c4_200m",
column_map: Optional[Dict[str, str]] = None,
train_on_input: bool = False,
system_prompt: Optional[str] = None,
Copy link
Contributor

Choose a reason for hiding this comment

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

I think these need to be updated to or at least the documentation stating that this will override any system prompt?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oi, missed these

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 95.12195% with 2 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@4ae950b). Learn more about missing BASE report.

Files Patch % Lines
torchtune/data/_messages.py 90.47% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1366   +/-   ##
=======================================
  Coverage        ?   72.69%           
=======================================
  Files           ?      271           
  Lines           ?    12805           
  Branches        ?        0           
=======================================
  Hits            ?     9308           
  Misses          ?     3497           
  Partials        ?        0           

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

None yet

4 participants