You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Prompt-Engineering-Guide/README.md

87 lines
4.6 KiB
Markdown

2 years ago
# Prompt Engineering Guide
2 years ago
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.
2 years ago
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
1 year ago
- 🌐 We now support [中文](https://www.promptingguide.ai/zh), [日本語](https://www.promptingguide.ai/jp), [Português](https://www.promptingguide.ai/pt), [Turkish](https://www.promptingguide.ai/tr) and [English](https://www.promptingguide.ai/). Welcoming more translations.
- 🎉 We have launched new web version of the guide [here](https://www.promptingguide.ai/)
1 year ago
- 🎓 Partnered with Sphere to deliver a new course on [Prompt Engineering for LLMs](https://www.getsphere.com/cohorts/prompt-engineering-for-llms?source=github)
1 year ago
- 🔥 We reached #1 on Hacker News on 21 Feb 2023
- 🎉 The Prompt Engineering Lecture went live [here](https://youtu.be/dOxUroR57xs)
1 year ago
1 year ago
[Join our Discord](https://discord.gg/FUyz9vPAwf)
1 year ago
[Follow us on Twitter](https://twitter.com/dair_ai)
1 year ago
[Subscribe to our Newsletter](https://nlpnews.substack.com/)
---
## 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/](https://www.promptingguide.ai/).
- [Prompt Engineering - Introduction](/guides/prompts-intro.md)
- [Prompt Engineering - Basic Prompting](/guides/prompts-basic-usage.md)
- [Prompt Engineering - Advanced Prompting](/guides/prompts-advanced-usage.md)
- [Prompt Engineering - Applications](/guides/prompts-applications.md)
- [Prompt Engineering - ChatGPT](/guides/prompts-chatgpt.md)
1 year ago
- [Prompt Engineering - Adversarial Prompting](/guides/prompts-adversarial.md)
- [Prompt Engineering - Reliability](/guides/prompts-reliability.md)
1 year ago
- [Prompt Engineering - Miscellaneous Topics](/guides/prompts-miscellaneous.md)
1 year ago
- [Prompt Engineering - Papers](/pages/papers.en.mdx)
- [Prompt Engineering - Tools](/pages/tools.en.mdx)
- [Prompt Engineering - Datasets](/pages/datasets.en.mdx)
1 year ago
- [Prompt Engineering - Additional Readings](/pages/readings.en.mdx)
2 years ago
1 year ago
## Lecture
We have published a 1 hour lecture that provides a comprehensive overview of prompting techniques, applications, and tools.
- [Video Lecture](https://youtu.be/dOxUroR57xs)
- [Notebook with code](https://github.com/dair-ai/Prompt-Engineering-Guide/blob/main/notebooks/pe-lecture.ipynb)
- [Slides](https://github.com/dair-ai/Prompt-Engineering-Guide/blob/main/lecture/Prompt-Engineering-Lecture-Elvis.pdf)
1 year ago
---
1 year ago
## Running the guide locally
1 year ago
1 year ago
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
1. Install `pnpm` if not present in your system. Check [here](https://pnpm.io/installation) for detailed instructions.
1. Install the dependencies: `pnpm i next react react-dom nextra nextra-theme-docs`
1. Boot the guide with `pnpm dev`
2. Browse the guide at `http://localhost:3000/`
---
1 year ago
## 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](https://www.wsj.com/articles/chatgpt-ask-the-right-question-12d0f035)
- Forbes - [Mom, Dad, I Want To Be A Prompt Engineer](https://www.forbes.com/sites/craigsmith/2023/04/05/mom-dad-i-want-to-be-a-prompt-engineer/?sh=7f1213159c8e)
- Markettechpost - [Best Free Prompt Engineering Resources (2023)](https://www.marktechpost.com/2023/04/04/best-free-prompt-engineering-resources-2023/)
2 years ago
---
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}
}
```
1 year ago
## License
[MIT License](https://github.com/dair-ai/Prompt-Engineering-Guide/blob/main/LICENSE.md)
Feel free to open a PR if you think something is missing here. Always welcome feedback and suggestions. Just open an issue!