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

feat: added cortex documentation #1225

Merged
merged 2 commits into from
Nov 28, 2024
Merged

feat: added cortex documentation #1225

merged 2 commits into from
Nov 28, 2024

Conversation

ivanleomk
Copy link
Collaborator

@ivanleomk ivanleomk commented Nov 28, 2024

Important

Adds documentation for Cortex integration with examples and updates navigation in index.md and mkdocs.yml.

  • Documentation:
    • Adds cortex.md to docs/integrations/ with a guide on using Cortex for structured outputs with Instructor.
    • Includes examples for synchronous, asynchronous, and nested data handling.
  • Navigation:
    • Updates index.md in docs/integrations/ to include Cortex.
    • Updates mkdocs.yml to add Cortex to the navigation under integrations.

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

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request size:L This PR changes 100-499 lines, ignoring generated files. labels Nov 28, 2024
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 2b2433e in 43 seconds

More details
  • Looked at 210 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. docs/integrations/cortex.md:71
  • Draft comment:
    The import statement for from_openai is missing in the async example. Add from instructor import from_openai to ensure consistency with the sync example.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable:
    The comment suggests a change that is not necessary for the code to function correctly. The instructor.from_openai is already accessible due to the import instructor statement. The comment seems to be more about stylistic consistency rather than a functional requirement.
    I might be overlooking a potential stylistic guideline that prefers direct imports for clarity. However, the current import method is valid and functional.
    The current import method is valid and does not affect the functionality of the code. The suggestion is more about style than necessity.
    The comment is not necessary as the current import method is valid and functional. The suggestion is more about stylistic consistency rather than a functional requirement.
2. docs/integrations/cortex.md:41
  • Draft comment:
    Repeated import of from instructor import from_openai violates DRY principle. Remove duplicate imports.
  • Reason this comment was not posted:
    Confidence changes required: 80%
    The PR adds a new documentation file for Cortex integration, and it has been correctly added to the mkdocs.yml file. However, there is a repeated import statement in the Python code examples that violates the DRY principle.

Workflow ID: wflow_KGT0Z10dvlVhNaSn


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

Copy link

cloudflare-workers-and-pages bot commented Nov 28, 2024

Deploying instructor-py with  Cloudflare Pages  Cloudflare Pages

Latest commit: d66fa96
Status: ✅  Deploy successful!
Preview URL: https://8904fb8e.instructor-py.pages.dev
Branch Preview URL: https://cortex-integration.instructor-py.pages.dev

View logs

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! Incremental review on d66fa96 in 24 seconds

More details
  • Looked at 21 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. docs/integrations/cortex.md:75
  • Draft comment:
    The import statement for from_openai is missing in the async example. Add from instructor import from_openai to ensure the code runs correctly.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
2. docs/integrations/cortex.md:78
  • Draft comment:
    The client initialization code is repeated in multiple examples. Consider refactoring to avoid repetition and adhere to the DRY principle.
  • Reason this comment was not posted:
    Confidence changes required: 80%
    The variable and function names are consistent and descriptive, but there is a repeated code block for initializing the client in multiple examples.

Workflow ID: wflow_O9XF1uym5HicQuLn


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

@ivanleomk ivanleomk merged commit 4c4a1ce into main Nov 28, 2024
14 of 15 checks passed
@ivanleomk ivanleomk deleted the cortex-integration branch November 28, 2024 05:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant