mirror of https://github.com/dair-ai/Prompt-Engineering-Guide synced 2024-11-19 21:25:35 +00:00

Go to file

Yujia Qin be949c8c85 Update papers.en.mdx		2023-04-21 09:08:46 +08:00
.github	Create FUNDING.yml	2023-02-01 18:22:13 -06:00
components	add pages	2023-03-10 20:21:43 -06:00
guides	Update prompts-applications.md	2023-04-03 15:58:14 -06:00
img	add react code example	2023-04-13 02:16:21 -06:00
lecture	add lecture slides	2023-02-19 07:51:04 -06:00
notebooks	add react code example	2023-04-13 02:16:21 -06:00
pages	Update papers.en.mdx	2023-04-21 09:08:46 +08:00
public	add favicon	2023-03-13 21:13:09 -06:00
.gitignore	remove folder	2023-04-13 02:21:31 -06:00
CITATION.cff	Update CITATION.cff	2023-01-28 15:34:03 -06:00
LICENSE.md	Create LICENSE.md	2022-12-17 14:12:10 -06:00
middleware.js	multilanguage support	2023-03-30 18:43:20 -06:00
next-env.d.ts	add site support	2023-03-10 17:22:18 -06:00
next.config.js	Merge branch 'main' into i18n_es	2023-04-14 06:19:39 -06:00
package-lock.json	config	2023-03-17 01:48:51 -06:00
package.json	removed sharp from package.json	2023-04-14 11:35:11 +02:00
pnpm-lock.yaml	change	2023-03-17 01:59:59 -06:00
README.md	discord	2023-04-17 21:11:41 -06:00
theme.config.tsx	discord	2023-04-17 21:11:41 -06:00
tsconfig.json	add site support	2023-03-10 17:22:18 -06:00

README.md

Prompt Engineering Guide

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.

Happy Prompting!

Announcements / Updates

🌐 We now support 中文, 日本語, Português, Turkish and English. Welcoming more translations.
🎉 We have launched new web version of the guide here
🎓 Partnered with Sphere to deliver a new course on Prompt Engineering for LLMs
🔥 We reached #1 on Hacker News on 21 Feb 2023
🎉 The Prompt Engineering Lecture went live here

Join our Discord

Subscribe to our Newsletter

Guides

Please note that the guides below are now outdated. You can 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:

Install Node >=18.0.0
Install pnpm if not present in your system. Check here for detailed instructions.
Install the dependencies: pnpm i next react react-dom nextra nextra-theme-docs
Boot the guide with pnpm dev
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, 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!