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 README.md including primitive types usage #464

Merged
merged 1 commit into from
Feb 23, 2024
Merged

Update README.md including primitive types usage #464

merged 1 commit into from
Feb 23, 2024

Conversation

Fakamoto
Copy link
Contributor

@Fakamoto Fakamoto commented Feb 23, 2024

Related to #446


Ellipsis 🚀 This PR description was created by Ellipsis for commit f571fbe.

Summary:

This PR updates the README.md to include a section demonstrating the usage of primitive types (str, int, float, bool) as response models in the Instructor library.

Key points:

  • Added a new section to README.md demonstrating the usage of primitive types as response models.
  • Included a code snippet showing a chat completion request using a boolean response model.

Generated with ❤️ by ellipsis.dev

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me!

  • Reviewed the entire pull request up to f571fbe
  • Looked at 36 lines of code in 1 files
  • Took 29 seconds to review
More info
  • Skipped 0 files when reviewing.
  • Skipped posting 1 additional comments because they didn't meet confidence threshold of 85%.
1. README.md:93:
  • Assessed confidence : 80%
  • Comment:
    The assertion error message 'Paris is the capital of France' might be misleading if the assertion fails. Consider changing it to something more descriptive, like 'Expected response to be True'.
  • Reasoning:
    The PR is updating the README.md file to include an example of how to use primitive types (str, int, float, bool) with the instructor library. The code seems to be logically correct, but there's a potential issue with the assertion message. The assertion message 'Paris is the capital of France' might be misleading if the assertion fails. It would be better to have a more descriptive error message that clearly indicates what went wrong.

Workflow ID: wflow_UJA4kGFuch3fZItU


Not what you expected? You can customize the content of the reviews using rules. Learn more here.

@Fakamoto
Copy link
Contributor Author

I think including that example will be enough for people to understand that instructor can handle all kinds of primitive types

@jxnl jxnl merged commit b6e7851 into instructor-ai:main Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants