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 google.md #1251

Merged
merged 1 commit into from
Dec 16, 2024
Merged

Update google.md #1251

merged 1 commit into from
Dec 16, 2024

Conversation

Filimoa
Copy link
Contributor

@Filimoa Filimoa commented Dec 12, 2024

If you do not install Vertex AI, you will get a strange jsonref import error. Also missing quotes.

#1184


Important

Update installation command in google.md to include vertexai to prevent jsonref import error.

  • Installation:
    • Update installation command in google.md to include vertexai in pip install "instructor[google-generativeai, vertexai]" to prevent jsonref import error.

This description was created by Ellipsis for 59359d2. It will automatically update as commits are pushed.

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 everything up to 59359d2 in 38 seconds

More details
  • Looked at 13 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. docs/integrations/google.md:15
  • Draft comment:
    Ensure that all quotes in the pip install command are properly closed to avoid syntax errors.
pip install "instructor[google-generativeai, vertexai]"
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
2. docs/integrations/google.md:15
  • Draft comment:
    If vertexai is a new addition to the library, ensure that the documentation is updated in mkdocs.yml to reflect this change.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable:
    The comment is relevant because it addresses a potential documentation update needed due to the addition of vertexai. This aligns with the rule that if library code changes, documentation should be updated. The comment is actionable and clear, suggesting a specific file to update.
    The comment assumes that vertexai is a new addition without explicit evidence from the diff. It could be an existing feature that is now being documented, in which case the comment might not be necessary.
    The addition of vertexai in the installation command strongly suggests a new feature or dependency, which typically requires documentation updates. The comment is a precautionary measure to ensure consistency in documentation.
    Keep the comment as it provides a useful reminder to update documentation in mkdocs.yml due to the addition of vertexai, which is likely a new feature or dependency.

Workflow ID: wflow_4BziTbc092QT8nxo


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@jxnl jxnl merged commit bce6e69 into instructor-ai:main Dec 16, 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