reformated README

pull/22/head
Elvis Saravia 2023-02-19 19:52:00 -06:00
parent 1089b0e9f0
commit 0ae2e4f437
6 changed files with 29 additions and 20 deletions

View File

@ -12,6 +12,7 @@ Announcements:
## Table of Contents
- [Lecture](#lecture)
- [Guides](#guides)
- [Papers](#papers)
- [Tools & Libraries](#tools--libraries)
@ -19,19 +20,28 @@ Announcements:
- [Blog, Guides, Tutorials and Other Readings](#blog-guides-tutorials-and-other-readings)
---
## Lecture
## Guides 🔮
We have published a 1 hour lecture that provides a comprehensive overview of prompting techniques, applications, and tools.
- [Video](https://youtu.be/dOxUroR57xs)
- [Notebook](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)
---
## Guides
The following are a set of guides on prompt engineering developed by us. Guides are work in progress.
- [Prompt Engineering - Introduction](/guides/prompts-intro.md)
- [Prompt Engineering - Basic Usage](/guides/prompts-basic-usage.md)
- [Prompt Engineering - Advanced Usage](/guides/prompts-advanced-usage.md)
- [Prompt Engineering - Adversarial Prompts](/guides/prompt-adversarial.md)
- [Prompt Engineering - Basic Prompting](/guides/prompts-basic-usage.md)
- [Prompt Engineering - Advanced Prompting](/guides/prompts-advanced-usage.md)
- [Prompt Engineering - Adversarial Prompting](/guides/prompt-adversarial.md)
- [Prompt Engineering - Miscellaneous Topics](/guides/prompt-miscellaneous.md)
---
## Papers
#### (Sorted by Release Date)
The following are the latest papers (sorted by release date) on prompt engineering. We update this on a daily basis and new papers come in. We incorporate summaries of these papers to the guides above every week.
- Surveys / Overviews:
@ -118,6 +128,7 @@ The following are a set of guides on prompt engineering developed by us. Guides
- [Papers with Code](https://paperswithcode.com/task/prompt-engineering)
- [Prompt Papers](https://github.com/thunlp/PromptPapers#papers)
---
## Tools & Libraries
#### (Sorted by Name)
@ -152,6 +163,7 @@ The following are a set of guides on prompt engineering developed by us. Guides
- [ThoughtSource](https://github.com/OpenBioLink/ThoughtSource)
- [Visual Prompt Builder](https://tools.saxifrage.xyz/prompt)
---
## Datasets
#### (Sorted by Name)
@ -165,6 +177,7 @@ The following are a set of guides on prompt engineering developed by us. Guides
- [Stable Diffusion Dataset](https://huggingface.co/datasets/Gustavosta/Stable-Diffusion-Prompts)
- [WritingPrompts](https://www.reddit.com/r/WritingPrompts)
---
## Blog, Guides, Tutorials and Other Readings
#### (Sorted by Name)
@ -227,10 +240,6 @@ The following are a set of guides on prompt engineering developed by us. Guides
- [The ChatGPT Prompt Book](https://docs.google.com/presentation/d/17b_ocq-GL5lhV_bYSShzUgxL02mtWDoiw9xEroJ5m3Q/edit#slide=id.gc6f83aa91_0_79)
- [Using GPT-Eliezer against ChatGPT Jailbreaking](https://www.alignmentforum.org/posts/pNcFYZnPdXyL2RfgA/using-gpt-eliezer-against-chatgpt-jailbreaking)
# Lecture + Tutorial
Full tutorial and lecture coming soon!
---
Feel free to open a PR if you think something is missing here. Always welcome feedback and suggestions.

View File

@ -2,7 +2,7 @@
The following are a set of guides on prompt engineering developed by us (DAIR.AI). Guides are work in progress.
- [Prompt Engineering - Introduction](/guides/prompts-intro.md)
- [Prompt Engineering - Basic Usage](/guides/prompts-basic-usage.md)
- [Prompt Engineering - Advanced Usage](/guides/prompts-advanced-usage.md)
- [Prompt Engineering - Adversarial Prompts](/guides/prompt-adversarial.md)
- [Prompt Engineering - Basic Prompting](/guides/prompts-basic-usage.md)
- [Prompt Engineering - Advanced Prompting](/guides/prompts-advanced-usage.md)
- [Prompt Engineering - Adversarial Prompting](/guides/prompt-adversarial.md)
- [Prompt Engineering - Miscellaneous Topics](/guides/prompt-miscellaneous.md)

View File

@ -78,6 +78,6 @@ And there are many other variations of this with the goal to make the model do s
Models like ChatGPT and Claude have been aligned to avoid outputting content that for instance promote illegal behavior or unethical activities. So it's harder to jailbreak them but they still have flaws and we are learning new ones as people experiment with these systems.
---
[Previous Section (Advanced Prompt Usage)](./prompts-advanced-usage.md)
[Previous Section (Advanced Prompting)](./prompts-advanced-usage.md)
[Next Section (Miscellaneous Topics)](./prompt-miscellaneous.md)

View File

@ -1,4 +1,4 @@
# Advanced Prompt Usage
# Advanced Prompting
By this point, it should be obvious that it helps to improve prompts to get better results on different tasks. That's the whole idea behind prompt engineering.
While those examples were fun, let's cover a few concepts more formally before we jump into more advanced concepts.
@ -331,6 +331,6 @@ Yes, part of golf is trying to get a higher point total than others. Each player
Some really interesting things happened with this example. In the first answer, the model was very confident but in the second not so much. I simplify the process for demonstration purposes but there are few more details to consider when arriving to the final answer. Check out the paper for more.
---
[Previous Section (Basic Prompts Usage)](./prompts-basic-usage.md)
[Previous Section (Basic Prompting)](./prompts-basic-usage.md)
[Next Section (Adversarial Prompting)](./prompt-adversarial.md)

View File

@ -1,4 +1,4 @@
# Basic Prompts Usage
# Basic Prompting
In the previous guide, we introduced and gave a basic example of a prompt.
@ -269,4 +269,4 @@ In the upcoming guides, we will cover even more advanced prompt engineering conc
[Previous Section (Prompts Introduction)](./prompts-intro.md)
[Next Section (Advanced Prompt Usage)](./prompts-advanced-usage.md)
[Next Section (Advanced Prompting Techniques)](./prompts-advanced-usage.md)

View File

@ -1,4 +1,4 @@
# Prompt Introduction
# Prompting Introduction
This guide covers the basics of standard prompts to provide a rough idea on how to use prompts to interact and instruct large language models (LLMs).
@ -138,4 +138,4 @@ As we cover more and more examples and applications that are possible with promp
A prompt can be composed of a question, instruction, input data, and examples. A question or instruction is a required component of a prompt. Depending on the task at hand, you might find it useful to also include more information like input data and examples. More on this in the upcoming guides.
---
[Next Section (Basic Prompts Usage)](./prompts-basic-usage.md)
[Next Section (Basic Prompting)](./prompts-basic-usage.md)