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

prompt docs #793

Merged
merged 17 commits into from
Jul 5, 2024
Merged

prompt docs #793

merged 17 commits into from
Jul 5, 2024

Conversation

shreya-51
Copy link
Collaborator

@shreya-51 shreya-51 commented Jun 30, 2024

[✅] stepback
[✅] active prompt
[✅ auto cot


🚀 This description was created by Ellipsis for commit ca27fb7

Summary:

Updated documentation for active prompting, automated CoT, and step-back prompting techniques, fixed a minor issue in role prompting, and updated navigation in mkdocs.yml.

Key points:

  • Updated docs/prompting/thought_generation/chain_of_thought_few_shot/active_prompt.md to include detailed steps for active prompting.
  • Updated docs/prompting/thought_generation/chain_of_thought_few_shot/auto_cot.md to describe automating CoT for diverse example selection.
  • Updated docs/prompting/thought_generation/chain_of_thought_zero_shot/step_back_prompting.md to explain step-back prompting technique.
  • Fixed minor formatting issue in docs/prompting/zero_shot/role_prompting.md.
  • Updated mkdocs.yml to reflect new and updated documentation paths.

Generated with ❤️ by ellipsis.dev

@shreya-51 shreya-51 changed the title add stepback prompting prompt docs Jun 30, 2024
@shreya-51 shreya-51 requested review from jxnl and ivanleomk July 3, 2024 05:20
@shreya-51 shreya-51 marked this pull request as ready for review July 3, 2024 05:20
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 ca27fb7 in 36 seconds

More details
  • Looked at 448 lines of code in 5 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. mkdocs.yml:226
  • Draft comment:
    The new documentation files active_prompt.md, auto_cot.md, and step_back_prompting.md are not added to the mkdocs.yml navigation structure. Please update the navigation to include these new files to ensure they are accessible through the website.
    - Prioritize annotating uncertain examples: 'prompting/thought_generation/chain_of_thought_few_shot/active_prompt.md'
    - Automate diverse example selection: 'prompting/thought_generation/chain_of_thought_few_shot/auto_cot.md'
    - Consider higher-level context: 'prompting/thought_generation/chain_of_thought_zero_shot/step_back_prompting.md'
  • Reason this comment was not posted:
    Confidence of 0% on close inspection, compared to threshold of 85%.

Workflow ID: wflow_TnogueLkIkfPReSp


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

Copy link
Collaborator

@ivanleomk ivanleomk 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! Just need to fix that one comment and should be ok to merge

@shreya-51 shreya-51 merged commit 3b8988e into jxnl:main Jul 5, 2024
@shreya-51 shreya-51 deleted the prompt_docs branch July 5, 2024 20:03
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.

None yet

3 participants