-
Notifications
You must be signed in to change notification settings - Fork 11.3k
Rewriting the cookbook introduction to update it and make it more user friendly. #2082
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
Conversation
Deleted 'how_to_work_with_large_language_models.md' and added 'llms 101.md' with a shorter, more focused overview of large language models. The new article provides a high-level introduction to LLMs, their capabilities, and basic concepts for users.
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 PR replaces the existing detailed LLM guide with a new, more accessible introductory article focused on making large language model concepts approachable for beginners. The rewrite emphasizes fundamental concepts in a concise, user-friendly format while removing outdated technical details.
- Introduces a new beginner-friendly article explaining LLM basics, capabilities, and core concepts
- Removes the previous comprehensive guide that contained outdated model references and dense technical content
- Streamlines documentation structure to be more welcoming for newcomers
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
File | Description |
---|---|
articles/llms-101.md | New introductory article providing accessible overview of LLM fundamentals and capabilities |
articles/how_to_work_with_large_language_models.md | Removal of existing detailed guide with outdated content and technical complexity |
Comments suppressed due to low confidence (1)
articles/llms-101.md:7
- This statement is outdated. ChatGPT was initially built on GPT-3.5, not GPT-3, and has since been upgraded to GPT-4. Consider updating to reflect the current state or use more general language like 'OpenAI's ChatGPT brought this architecture into the spotlight'.
OpenAI’s ChatGPT, built on GPT-3, brought this architecture into the spotlight and kicked off today’s wave of AI applications.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: paytonison <148833579+paytonison@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…89be-5bd8110247a2 Add CONTRIBUTORS.md file with comprehensive contributor acknowledgment
whoopsie-doodles
Co-authored-by: paytonison <148833579+paytonison@users.noreply.github.com>
…8add-10fedf718e92 Add OpenAI Cookbook - LLMs 101 article to registry
TL;DR: Rewrites the Cookbook introduction for clarity and usability. Adds quick-start Python/JS examples, streaming demo, glossary, and practical guidance on knobs, limits, and best practices.
Summary
This PR rewrites the Cookbook introduction to make it more user-friendly, actionable, and code-first.
The previous version gave a high-level overview but lacked copy-pasteable examples and practical guidance.
This rewrite focuses on the “developer experience” by giving readers immediate, working snippets and clear mental models.
What’s Changed
Why This Helps
Notes for Reviewers
✅ Clearer, friendlier, and more actionable for first-time Cookbook readers.
For new content
When contributing new content, read through our contribution guidelines, and mark the following action items as completed:
We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.