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

finish + revise prompt design docs [few-shot] #982

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

shreya-51
Copy link
Collaborator

@shreya-51 shreya-51 commented Sep 6, 2024

[✅] sgicl
[✅] example ordering
[] knn
[] votek


🚀 This description was created by Ellipsis for commit 930643a

Summary:

This PR revises the SG-ICL documentation by updating example generation methods, renaming sections for clarity, and ensuring consistency across navigation files.

Key points:

  • Updated docs/prompting/few_shot/example_generation/sg_icl.md to improve explanation and implementation of SG-ICL.
  • Changed class names and function parameters in sg_icl.md for clarity and consistency.
  • Renamed section in docs/prompting/index.md from "Auto-Generate Examples" to "Generate Examples".
  • Updated mkdocs.yml to reflect changes in navigation titles for consistency.

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 everything up to 930643a in 13 seconds

More details
  • Looked at 193 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. docs/prompting/few_shot/example_generation/sg_icl.md:30
  • Draft comment:
    The parameter names input and case in generate_example should be more descriptive to match the updated function purpose. Consider renaming input to example_input and case to expected_output.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR modifies the function names and class names to be more generic, which is a good practice for reusability. However, the function parameters should also be updated to reflect these changes.
2. docs/prompting/few_shot/example_generation/sg_icl.md:50
  • Draft comment:
    The parameter names examples and input in inference should be more descriptive to match the updated function purpose. Consider renaming examples to in_context_examples and input to query_input.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR modifies the function names and class names to be more generic, which is a good practice for reusability. However, the function parameters should also be updated to reflect these changes.

Workflow ID: wflow_JKcRpiCozXsMp663


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

@shreya-51 shreya-51 marked this pull request as draft September 6, 2024 02:48
Copy link

cloudflare-workers-and-pages bot commented Sep 8, 2024

Deploying instructor with  Cloudflare Pages  Cloudflare Pages

Latest commit: f4bc933
Status: ✅  Deploy successful!
Preview URL: https://b8d640d5.instructor.pages.dev
Branch Preview URL: https://revise-few-shot-docs.instructor.pages.dev

View logs

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.

1 participant