prompt-engineering-guide

πŸ™ Guides, papers, lecture, notebooks and resources for prompt engineering

https://github.com/dair-ai/prompt-engineering-guide

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • βœ“
    CITATION.cff file
    Found CITATION.cff file
  • βœ“
    codemeta.json file
    Found codemeta.json file
  • βœ“
    .zenodo.json file
    Found .zenodo.json file
  • β—‹
    DOI references
  • β—‹
    Academic publication links
  • βœ“
    Committers with academic emails
    3 of 207 committers (1.4%) from academic institutions
  • β—‹
    Institutional organization owner
  • β—‹
    JOSS paper metadata
  • β—‹
    Scientific vocabulary similarity
    Low similarity (10.6%) to scientific vocabulary

Keywords

chatgpt deep-learning generative-ai language-model openai prompt-engineering

Keywords from Contributors

transformer large-language-models gpt-4 jax gpt-3 deepseek prompt cryptography audio gemma
Last synced: 6 months ago · JSON representation ·

Repository

πŸ™ Guides, papers, lecture, notebooks and resources for prompt engineering

Basic Info
Statistics
  • Stars: 61,248
  • Watchers: 647
  • Forks: 6,314
  • Open Issues: 223
  • Releases: 0
Topics
chatgpt deep-learning generative-ai language-model openai prompt-engineering
Created about 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Funding License Citation

README.md

Prompt Engineering Guide

Sponsored by    

Prompt engineering is a relatively new discipline for developing and optimizing prompts to efficiently use language models (LMs) for a wide variety of applications and research topics. Prompt engineering skills help to better understand the capabilities and limitations of large language models (LLMs). Researchers use prompt engineering to improve the capacity of LLMs on a wide range of common and complex tasks such as question answering and arithmetic reasoning. Developers use prompt engineering to design robust and effective prompting techniques that interface with LLMs and other tools.

Motivated by the high interest in developing with LLMs, we have created this new prompt engineering guide that contains all the latest papers, learning guides, lectures, references, and tools related to prompt engineering for LLMs.

🌐 Prompt Engineering Guide (Web Version)

πŸŽ‰ We are excited to launch our new prompt engineering, RAG, and AI Agents courses under the DAIR.AI Academy. Join Now!

The courses are meant to compliment this guide and provide a more hands-on approach to learning about prompt engineering, context engineering, and AI Agents.

Use code PROMPTING20 to get an extra 20% off.

Happy Prompting!


Announcements / Updates

  • πŸŽ“ We now offer self-paced prompt engineering courses under our DAIR.AI Academy. Join Now!
  • πŸŽ“ New course on Prompt Engineering for LLMs announced! Enroll here!
  • πŸ’Ό We now offer several services like corporate training, consulting, and talks.
  • 🌐 We now support 13 languages! Welcoming more translations.
  • πŸ‘©β€πŸŽ“ We crossed 3 million learners in January 2024!
  • πŸŽ‰ We have launched a new web version of the guide here
  • πŸ”₯ We reached #1 on Hacker News on 21 Feb 2023
  • πŸŽ‰ The First Prompt Engineering Lecture went live here

Join our Discord

Follow us on Twitter

Subscribe to our YouTube

Subscribe to our Newsletter


Guides

You can also find the most up-to-date guides on our new website https://www.promptingguide.ai/.


Lecture

We have published a 1 hour lecture that provides a comprehensive overview of prompting techniques, applications, and tools. - Video Lecture - Notebook with code - Slides


Running the guide locally

To run the guide locally, for example to check the correct implementation of a new translation, you will need to:

  1. Install Node >=18.0.0
  2. Install pnpm if not present in your system. Check here for detailed instructions.
  3. Install the dependencies: pnpm i next react react-dom nextra nextra-theme-docs
  4. Boot the guide with pnpm dev
  5. Browse the guide at http://localhost:3000/

Appearances

Some places where we have been featured: - Wall Street Journal - ChatGPT Can Give Great Answers. But Only If You Know How to Ask the Right Question - Forbes - Mom, Dad, I Want To Be A Prompt Engineer - Markettechpost - Best Free Prompt Engineering Resources (2023)


If you are using the guide for your work or research, please cite us as follows:

@article{Saravia_Prompt_Engineering_Guide_2022, author = {Saravia, Elvis}, journal = {https://github.com/dair-ai/Prompt-Engineering-Guide}, month = {12}, title = {{Prompt Engineering Guide}}, year = {2022} }

License

MIT License

Feel free to open a PR if you think something is missing here. Always welcome feedback and suggestions. Just open an issue!

Owner

  • Name: DAIR.AI
  • Login: dair-ai
  • Kind: organization
  • Location: Planet Earth

Democratizing Artificial Intelligence Research, Education, and Technologies

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Saravia"
  given-names: "Elvis"
title: "Prompt Engineering Guide"
date-released: 2022-12-16
url: "https://github.com/dair-ai/Prompt-Engineering-Guide"
preferred-citation:
  type: article
  authors:
  - family-names: "Saravia"
    given-names: "Elvis"
  month: 12
  journal: "https://github.com/dair-ai/Prompt-Engineering-Guide"
  title: "Prompt Engineering Guide"
  year: 2022

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 1,113
  • Total Committers: 207
  • Avg Commits per committer: 5.377
  • Development Distribution Score (DDS): 0.599
Past Year
  • Commits: 73
  • Committers: 6
  • Avg Commits per committer: 12.167
  • Development Distribution Score (DDS): 0.521
Top Committers
Name Email Commits
Elvis Saravia e****e@g****m 446
S4M 1****I 52
Erik Behrends b****s 40
ThunderCat t****p@y****m 37
Giornale di Sistema g****a@g****m 31
Ilya Gusev m****l@i****u 27
napo n****o@f****u 19
100pearlcent 1****t@n****m 16
Igor Kotenkov s****g@g****m 15
Mahmoud Mabrouk r****s@g****m 14
SUNWOO\sunw0 m****v@g****m 14
Ritvik19 r****9@g****m 12
Aitor GarcΓ­a Rey a****r@l****m 11
cuiw c****w@z****m 10
aaadddfgh 5****h 9
Jungwon Kim j****1@g****m 8
Lee-ye-ji d****9@g****m 7
Tao Li t****d@g****m 7
bik1111 b****1@k****r 7
Esantomi p****a@g****m 6
Dennis s****0@h****m 6
SnowWarri0r g****A@g****m 6
Pt J p****j@k****m 6
Pedro Mosquera p****t@g****m 6
Brandon Awan b****n@a****m 5
tanersekmen 5****n 5
sunday-sketching f****s@g****m 5
onestone9900 d****1@g****m 5
Welyson 5****1 5
Hr0803 a****3@n****m 5
and 177 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 191
  • Total pull requests: 564
  • Average time to close issues: 2 months
  • Average time to close pull requests: 12 days
  • Total issue authors: 170
  • Total pull request authors: 232
  • Average comments per issue: 0.73
  • Average comments per pull request: 1.13
  • Merged pull requests: 351
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 53
  • Pull requests: 157
  • Average time to close issues: 12 days
  • Average time to close pull requests: 10 days
  • Issue authors: 48
  • Pull request authors: 47
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.82
  • Merged pull requests: 52
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • omarsar (6)
  • KRGHD (3)
  • honam-jigo (3)
  • Kondreddy-madhava (2)
  • Sam-786-18 (2)
  • Anusha-847 (2)
  • 100pearlcent (2)
  • jitpaul01 (2)
  • jannikjw (2)
  • Ganasal (2)
  • Vandivier (2)
  • alosslessdev (2)
  • DomLah (2)
  • akshitpareta (2)
  • aboutmydreams (2)
Pull Request Authors
  • S4MFI (71)
  • behrends (51)
  • 100pearlcent (14)
  • ThunderCatXp (12)
  • giornaledisistema (9)
  • shizidushu (7)
  • tanersekmen (7)
  • taolicd (6)
  • mghiasvand1 (6)
  • harheem (6)
  • omarsar (6)
  • lowwilliam (5)
  • 11mLLM (5)
  • welyson1 (5)
  • vancostle (4)
Top Labels
Issue Labels
enhancement (10) translation (6) documentation (2) help wanted (1) bug (1)
Pull Request Labels
Review effort 1/5 (5) Review effort 2/5 (5) improvements (1) enhancement (1)