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

Adds __repr__ to Message #1757

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Adds __repr__ to Message #1757

merged 2 commits into from
Oct 8, 2024

Conversation

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

Fixes #1639

Updating __repr__ configures the output for __str__ as well. This PR diffs a little from the initial proposal by printing out the list of items. The content type is not printed out, since it can be inferred from the __repr__ itself. i.e. strings are printed directly and Image uses the __repr__ from PIL.

Changelog

  • Adds __repr__ to Message.

Test plan

  • 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

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

Copy link

pytorch-bot bot commented Oct 6, 2024

🔗 Helpful Links

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

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

✅ No Failures

As of commit c4616d6 with merge base a8a64ec (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 Oct 6, 2024
Copy link
Contributor

@joecummings joecummings left a comment

Choose a reason for hiding this comment

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

Super clean PR and thanks for adding tests!

Just one nit.

@@ -136,6 +136,10 @@ def _validate_message(self) -> None:
f"Only assistant messages can be tool calls. Found role {self.role} in message: {self.text_content}"
)

def __repr__(self) -> str:
content_only = [content["content"] for content in self.content]
return f"Message(role={self.role!r}, content={content_only!r})"
Copy link
Contributor

Choose a reason for hiding this comment

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

The repr call for role is not necessary as it will always just be a string.

@RdoubleA
Copy link
Contributor

RdoubleA commented Oct 8, 2024

awesome awesome, thanks for adding this!

@RdoubleA RdoubleA merged commit 37337f7 into pytorch:main Oct 8, 2024
17 checks passed
@joecummings joecummings mentioned this pull request Oct 9, 2024
34 tasks
mori360 pushed a commit to mori360/torchtune that referenced this pull request Oct 14, 2024
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.

Implement __str__ in Message
4 participants