Prompt-Engineering-Guide README

The project's README from github.com/dair-ai/Prompt-Engineering-Guide. As one markdown file: 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

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.


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:


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!

Prompt-Engineering-Guide (dair-ai/Prompt-Engineering-Guide)

Searching Database…

What is this?This is DAIR.AI's Prompt Engineering Guide: a large, continuously updated collection of guides, papers, lecture notes, and notebooks covering prompt engineering techniques, context engineering, retrieval-augmented generation (RAG), and building AI agents with LLMs.
Is this a software tool, or a collection of guides and papers to read?It is a reference and documentation site rather than a software library - a curated set of write-ups on techniques, models, and papers. The repo also builds the guide into a Next.js/Nextra web app, published online as the Web Version.
Where should a beginner start in the guide?The guide is organized into numbered sections; a newcomer should start with the Introduction and LLM Settings pages before moving on to techniques like zero-shot, few-shot, and Chain-of-Thought prompting.
Do I need anything special to run the guide locally?Only if you want to run the site locally, for example to check a translation: you need Node >=18 and pnpm, then install the Next.js/Nextra dependencies and run pnpm dev. Just reading the guide online requires nothing.
Is the content kept up to date and available in multiple languages?The project is actively maintained - it has crossed 3 million learners, added a video lecture, and supports 13 languages with more translations welcomed, so content keeps expanding rather than going stale.
What topics does the guide cover beyond the basics?It goes deep into techniques like Zero-Shot and Few-Shot prompting, Chain-of-Thought, Tree of Thoughts, ReAct, RAG, and function calling, plus model-specific notes for ChatGPT, GPT-4, LLaMA, Gemini, Mistral, and Mixtral.
Is there a video lecture or paid course alongside the guide?Yes - there is a free 1-hour video lecture with slides and a notebook, plus paid, self-paced prompt engineering, RAG, and AI Agents courses under DAIR.AI Academy.
Has this guide gotten any outside recognition?It hit number 1 on Hacker News in February 2023 and has been covered by the Wall Street Journal and Forbes.
Why did DAIR.AI create this guide?DAIR.AI built it to consolidate papers, techniques, and tools around prompting because of high developer and researcher interest in getting more reliable and capable output from LLMs.
Creator
dair-ai
Size
80.8 MB
Stars
79.3K
Updated
CommitMar 11
Age
3y
Commits · 90 Days