Skip to content

Commit

Permalink
translate latest prompt_engineering, prompting, intro into Chinese (#…
Browse files Browse the repository at this point in the history
…1082)

* docs: translate latest basics/intro into Chinese

* docs: translate latest prompting.md into zh-Hans

* docs: translate latest prompt_engineering to zh

* docs: translate embeds

---------

Co-authored-by: mengjun.guo <[email protected]>
  • Loading branch information
AnattaGuo and mengjun.guo authored Sep 25, 2023
1 parent 8d87cda commit f4f3d12
Show file tree
Hide file tree
Showing 13 changed files with 497 additions and 104 deletions.
6 changes: 6 additions & 0 deletions glossary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,9 @@ ejemplos:
prompting de CoT:
term: prompting de CoT
def: La idea principal de CoT es que al mostrarle al LLM algunos ejemplos de few-shot donde se explica el proceso de razonamiento en los ejemplos, el LLM también mostrará el proceso de razonamiento al responder a la solicitud.

## Chinese definitions

prompt zh-hans:
term: prompt
def: 提供给生成式 AI 的文本或其他输入
2 changes: 1 addition & 1 deletion i18n/zh-Hans/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"message": "💼 基础应用"
},
"sidebar.tutorialSidebar.category.😃 Basics.link.generated-index.description": {
"message": "什么是提示工程和一些提示工程的简单技巧"
"message": "本章介绍了生成式 AI、提示、提示工程以及Chatbots等基础知识。"
},
"sidebar.tutorialSidebar.category.🧙‍♂️ Intermediate": {
"message": "🧙‍♂️ 进阶"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 80
sidebar_position: 9
---

# 🟢 聊天机器人基础
Expand Down Expand Up @@ -27,7 +27,7 @@ ChatGPT 的回答常以中性正式的语气表达,同时提供一些细节,

一个更详细的风格提示的例子可能是:

>[问题]以拥有20多年经验和多个博士学位的[领域]专家的风格和水平写作。在回答中优先考虑有建设性的、不太知名的建议。使用详细的例子进行解释,尽量少离题和耍幽默。“
> [问题]以拥有 20 多年经验和多个博士学位的[领域]专家的风格和水平写作。在回答中优先考虑有建设性的、不太知名的建议。使用详细的例子进行解释,尽量少离题和耍幽默。“
使用风格输入提示将大大提高回答的质量!

Expand All @@ -36,15 +36,16 @@ ChatGPT 的回答常以中性正式的语气表达,同时提供一些细节,
如果你只想改变语气或微调提示而不是重新格式化,添加**描述符**是一个不错的方法。简单地在提示后面添加一两个词可以改变聊天机器人解释或回复您的信息的方式。你可以尝试添加形容词,如“有趣的”、“简短的”、“不友好的”、“学术语法”等,看看答案如何变化!

## 引导提示(Priming Prompt)

聊天机器人对话的结构决定,你给 LLM 的第一个提示的形式将会影响后续的对话,从而让你能够添加额外的结构和规范。
举个例子,让我们定义一个系统,允许我们在同一会话中与教师和学生进行对话。我们将为学生和教师的限定说话风格,指定我们想要回答的格式,并包括一些语法结构,以便能够轻松地调整我们的提示来尝试各种回答。

“教师”代表一个在该领域拥有多个博士学位、教授该学科超过十年的杰出教授的风格。您在回答中使用学术语法和复杂的例子,重点关注不太知名的建议以更好地阐明您的论点。您的语言应该是精炼而不过于复杂。如果您不知道问题的答案,请不要胡乱编造信息——相反,提出跟进问题以获得更多背景信息。您的答案应以对话式的段落形式呈现。使用学术性和口语化的语言混合,营造出易于理解和引人入胜的语气。

“学生”代表一个具有该学科入门级知识的大学二年级学生的风格。您使用真实生活的例子简单解释概念。使用非正式的、第一人称的语气,使用幽默和随意的语言。如果您不知道问题的答案,请不要编造信息——相反,澄清您还没有学到这个知识点。您的答案应以对话式的段落形式呈现。使用口语化的语言,营造出有趣和引人入胜的语气。

“批评”代表分析给定文本并提供反馈的意思。
“总结”代表提供文本的关键细节。
“批评”代表分析给定文本并提供反馈的意思。
“总结”代表提供文本的关键细节。
“回答”代表从给定的角度回答问题的意思。

圆括号()中的内容表示您写作的角度。
Expand All @@ -53,7 +54,7 @@ ChatGPT 的回答常以中性正式的语气表达,同时提供一些细节,
例子:(学生){哲学}[回答] 在大学里选择这门课程相比其他课程有什么优势?

如果您理解并准备开始,请回答“是”。

import unprimed_question from '@site/docs/assets/basics/unprimed_question.webp';
import primed_question from '@site/docs/assets/basics/primed_question.webp';

Expand All @@ -75,4 +76,4 @@ import primed_question from '@site/docs/assets/basics/primed_question.webp';

🚧 这个页面需要引用 🚧

By [Dastardi](https://twitter.com/lukescurrier)
By [Dastardi](https://twitter.com/lukescurrier)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
locale: zh-Hans
style: chicago
---
Expand All @@ -8,7 +8,6 @@ style: chicago

import CombinedPrompt from '@site/docs/assets/basics/combined_prompt.svg';


<div style={{textAlign: 'center'}}>
<CombinedPrompt style={{width:"500px",height:"300px",verticalAlign:"top"}}/>
</div>
Expand Down Expand Up @@ -37,4 +36,4 @@ A:

通过添加额外的上下文和示例,我们通常可以提高人工智能在不同任务上的表现。

By [gezilinll](https://github.com/gezilinll).
By [gezilinll](https://github.com/gezilinll).
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
sidebar_position: 3
---

# 🟢 学习提示嵌入

:::takeaways 本文要点

- 配置学习提示嵌入(Learn Prompting Embed)
- 在课程网站上运行 ChatGPT 的提示

:::

The ChatGPT website is useful, but wouldn't it be nice if you could write and test prompts right on this website? With [Learn Prompting Embeds](https://embed.learnprompting.org/), you can! Read on to see how to set this up. We will include these interactive embeds in the most articles.

ChatGPT 网站非常有用,但如果你能在本网站上编写和测试提示,那不是更好吗?通过[学习提示嵌入](https://embed.learnprompting.org/)(Learn Prompting Embeds),你可以实现这一点!继续阅读以了解如何设置。我们将在大多数文章中包含这些交互式嵌入。

## 准备工作

观看视频教程:

<iframe width="560" height="315" src="https://www.youtube.com/embed/sNUKiwd2DWU" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowFullScreen></iframe>

Here is an **image** of what an embed looks like:

import lp_embed from '@site/docs/assets/basics/lp_embed.webp';
import key from '@site/docs/assets/basics/API_key.webp';

<img src={lp_embed} class="img-docs" style={{width: "100%"}}/>

You should be able to see an embed that looks just like the image right below this paragraph. If it is not visible, you may need to enable JavaScript or use a different browser. If you still cannot see it, join the [Discord](https://discord.com/invite/learn-prompting) and tell us about your problem.

<iframe
src="https://embed.learnprompting.org/embed?config=eyJ0b3BQIjowLCJ0ZW1wZXJhdHVyZSI6MCwibWF4VG9rZW5zIjoyNTYsIm91dHB1dCI6IkNob2NvbGF0ZSwgVmFuaWxsYSwgU3RyYXdiZXJyeSwgTWludCBDaGlwLCBSb2NreSBSb2FkLCBDb29raWUgRG91Z2gsIEJ1dHRlciBQZWNhbiwgTmVhcG9saXRhbiwgQ29mZmVlLCBDb2NvbnV0IiwicHJvbXB0IjoiR2VuZXJhdGUgYSBjb21tYSBzZXBhcmF0ZWQgbGlzdCBvZiAxMCBpY2UgY3JlYW0gZmxhdm9yczoiLCJtb2RlbCI6ImdwdC0zLjUtdHVyYm8ifQ%3D%3D"
style={{width:"100%", height:"320px", border:"0", borderRadius:"4px", overflow:"hidden"}}
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
></iframe>
Assuming that you can see the embed, click on the **Generate** button. If this is your first time using it, you will be prompted to input an OpenAI API key. An OpenAI API key is just a string of text that the embed uses to link to your OpenAI account.

### Get an OpenAI API Key

- First, navigate to [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys)
- Then, sign up for or sign into your OpenAI account.
- Click the **Create new secret key** button. It will pop up a modal that contains a string of text like this:

<div style={{textAlign: 'center'}}>
<LazyLoadImage src={key} class="img-docs" style={{width: "80%"}} />
</div>

- Copy and paste this key into the embed on this website and click **Submit**.

You should now be able to use the embeds throughout this site. Note that OpenAI charges you for each prompt you submit through these embeds. If you have recently created a new account, you should have 3 months of free credits. If you have run out of credits, don't worry, since using these models is very cheap. ChatGPT only costs about $0.02 for every seven thousand words you generate[^a].

### Using the Embed

Let's learn how to use the embed. Edit the "Type your prompt here" field. This embed is effectively the same as using ChatGPT, except that you cannot have a full conversation. In this course, the embeds are just used to show examples of prompt engineering techniques.

<iframe
src="https://embed.learnprompting.org/embed?config=eyJ0b3BQIjowLCJ0ZW1wZXJhdHVyZSI6MCwibWF4VG9rZW5zIjoyNTYsIm91dHB1dCI6Ik91dHB1dCBhcHBlYXJzIGhlcmUiLCJwcm9tcHQiOiJUeXBlIHlvdXIgcHJvbXB0IGhlcmUiLCJtb2RlbCI6ImdwdC0zLjUtdHVyYm8ifQ%3D%3D"
style={{width:"100%", height:"300px", border:"0", borderRadius:"4px", overflow:"hidden"}}
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
></iframe>
You can see four pieces of information under the Generate button. The left one, 'gpt-3.5-turbo' is the model (gpt-3.5-turbo is the technical name for ChatGPT). The three numbers are [LLM settings](https://learnprompting.org/docs/basics/configuration_hyperparameters), which we will learn about in a few articles. If you would like to make your own embed, click the
edit this embed button.

## Conclusion

These embeds will make it easier for you to learn throughout the course, since you can quickly test your prompts, without clicking into a different tab. However, you do not have to use the embeds if you prefer the ChatGPT interface. Just continue to copy and paste prompts into ChatGPT. If you do intend to use the embeds, write down your API key somewhere, since the OpenAI website only allows you to see it once.

:::caution
Never tell anyone your API key, since they could charge your account with prompts.
:::

[^a]: See full pricing information [here](https://openai.com/pricing)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 6
---

# 🟢 多范例提示
Expand All @@ -10,7 +10,6 @@ import FewShot from '@site/docs/assets/basics/few_shot.svg';
<FewShot style={{width:"800px",height:"300px",verticalAlign:"top"}}/>
</div>


另一个提示策略是*多范例提示(few shot prompting)*, 这种策略将为模型展示一些例子(shots),从而更形象地描述你的需求。

在上图的例子中,我们尝试对用户反馈进行正面(positive)或反面(negative)的分类。我们向模型展示了 3 个例子,然后我们输入一个不在例子里面的反馈(`It doesnt work!:`)。模型发现头三个例子都被分类到 `positive` 或者 `negative` ,进而通过这些信息将我们最后输入的反馈分类到了 `negative`
Expand Down Expand Up @@ -50,11 +49,13 @@ import FewShot from '@site/docs/assets/basics/few_shot.svg';
单词 `shot` 在该场景下与 `example(范例)` 一致。除了多范例提示(few-shot prompting)之外,还有另外两种不同的类型。它们之间唯一的区别就是你向模型展示了多少范例。

类型:

- 无范例提示(0 shot prompting): 不展示范例
- 单范例提示(1 shot prompting): 只展示 1 条范例
- 多范例提示(few shot prompting): 展示 2 条及以上的范例

### 无范例提示

无范例提示是最基本的提示形式。它仅仅是向模型展示提示信息,没有提供任何示例,并要求其生成回答。因此,你到目前为止看到的所有指令和角色提示都属于无范例提示。无范例提示的另一个例子是:

```text
Expand All @@ -66,7 +67,7 @@ Add 2+2:
### 单范例提示

单范例提示是向模型展示一个示例。例如:

```text
Add 3+3: 6
Add 2+2:
Expand All @@ -76,18 +77,18 @@ Add 2+2:

### 多范例提示

多范例提示是向模型展示2个或更多示例。例如:
多范例提示是向模型展示 2 个或更多示例。例如:

```text
Add 3+3: 6
Add 5+5: 10
Add 2+2:
```

这是我们向模型展示了至少2个完整的示例(“Add 3+3: 6”和“Add 5+5: 10”)。通常,展示给模型的示例越多,输出结果就越好,因此在大多数情况下,多范例提示比另外两种提示更受欢迎。
这是我们向模型展示了至少 2 个完整的示例(“Add 3+3: 6”和“Add 5+5: 10”)。通常,展示给模型的示例越多,输出结果就越好,因此在大多数情况下,多范例提示比另外两种提示更受欢迎。

## 结论

多范例提示是让模型生成准确且格式正确的输出的强大技术!
By [gezilinll](https://github.com/gezilinll).

By [gezilinll](https://github.com/gezilinll).
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
---

# 🟢 规范化提示
Expand Down Expand Up @@ -46,7 +46,6 @@ import FormalPrompt from '@site/docs/assets/basics/formal_prompt.svg';

然而,第二个提示其实更好,原因是指令是提示的最后一部分,这时候语言模型将更倾向于按指令执行而不是进一步输出上下文相关的信息。例如,如果给定第一个提示,语言模型可能会回复:`2022年3月15日:与神经科医生预约随访,以评估脑震荡恢复进展`,而不是直接预测患者的风险。


## 一份 “标准的” 提示

到目前为止,我们已经了解了几种不同格式的提示。现在,我们将定义一个“标准的”提示是什么样子的。根据 Kojima 等人的说法(@kojima2022large),我们将仅由问题组成的提示称为“标准”提示,同时,仅由问题组成且以 QA 格式存在的提示也是“标准”提示。
Expand All @@ -57,13 +56,14 @@ import FormalPrompt from '@site/docs/assets/basics/formal_prompt.svg';

### 两个标准提示的例子:


_标准提示_

```
法国首都是什么?
```

_QA 格式的标准提示_

```
Q: 法国首都是什么?
Expand All @@ -87,6 +87,7 @@ _多示例标准提示_
```

_QA 格式的多示例标准提示_

```
Q:西班牙的首都是什么?
A:马德里
Expand All @@ -98,4 +99,4 @@ A:

多示例提示有助于上下文学习,这意味着模型无需更新参数就能够进行学习输出(@zhao2021calibrate)。

By [gezilinll](https://github.com/gezilinll).
By [gezilinll](https://github.com/gezilinll).
Loading

1 comment on commit f4f3d12

@vercel
Copy link

@vercel vercel bot commented on f4f3d12 Sep 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

learn-prompting – ./

learn-prompting.vercel.app
learn-prompting-trigaten.vercel.app
learn-prompting-git-main-trigaten.vercel.app

Please sign in to comment.