-
Notifications
You must be signed in to change notification settings - Fork 11.4k
Compile all prompting-related example notebooks into a single directory #2164
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
base: main
Are you sure you want to change the base?
Conversation
…ry for the sake of posterity
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request reorganizes prompting-related example notebooks by consolidating them into a single examples/prompting
directory. The changes update file paths in the registry and documentation to reflect this new organizational structure.
- Moved 13 notebook entries from various directories (
examples/
,examples/gpt-5/
,examples/o-series/
) toexamples/prompting/
- Updated documentation example to reference the new directory structure
- Maintained all existing metadata (dates, authors, tags) while updating only the file paths
Reviewed Changes
Copilot reviewed 2 out of 154 changed files in this pull request and generated no comments.
File | Description |
---|---|
registry.yaml | Updated paths for 13 prompting-related notebooks to use the new examples/prompting/ directory structure |
AGENTS.md | Updated the example notebook naming convention to reference the correct directory path |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Charlie Weems <[email protected]>
…ry for the sake of posterity
This reverts commit 2ce7c32.
This pull request updates documentation to clarify notebook naming conventions. The main change is to ensure new notebooks use lowercase, dash-or-underscore-separated names that match their directory, specifically updating the example path to use
examples/prompting
instead ofexamples/gpt-5
.AGENTS.md
to reference the correct directory (examples/prompting/prompt-optimization-cookbook.ipynb
) for clarity and consistency.Motivation
Prompting is the final frontier of AI models, regardless of the kind. A vast majority of issues people experience with AI models can be solved by prompting well. These are some basic examples with some decent advice for newbies, but they were all over the place. This solves that.
If there are issues, blame Codex.