github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-17 10:13:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

typo bugfixes in getting started with prompts (#651)

Browse Source 
tl;dr: input -> word, output -> antonym, rename to dynamic_prompt
consistently

The provided code in this example doesn't run, because the keys are
`word` and `antonym`, rather than `input` and `output`.

Also, the `ExampleSelector`-based prompt is named `few_shot_prompt` when
defined and `dynamic_prompt` in the follow-up example. The former name
is less descriptive and collides with an earlier example, so I opted for
the latter.

Thanks for making a really cool library!
This commit is contained in:
Charles Frye 2023-01-19 07:05:20 -08:00 committed by GitHub
parent 3adc5227cd
commit bfb23f4608
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/modules/prompts/getting_started.md
View File

@ -155,11 +155,11 @@ from langchain.prompts.example_selector import LengthBasedExampleSelector
# These are a lot of examples of a pretend task of creating antonyms. # These are a lot of examples of a pretend task of creating antonyms.
examples = [ examples = [
{"input": "happy", "output": "sad"}, {"word": "happy", "antonym": "sad"},
{"input": "tall", "output": "short"}, {"word": "tall", "antonym": "short"},
{"input": "energetic", "output": "lethargic"}, {"word": "energetic", "antonym": "lethargic"},
{"input": "sunny", "output": "gloomy"}, {"word": "sunny", "antonym": "gloomy"},
{"input": "windy", "output": "calm"}, {"word": "windy", "antonym": "calm"},
] ]
# We'll use the `LengthBasedExampleSelector` to select the examples. # We'll use the `LengthBasedExampleSelector` to select the examples.
@ -174,7 +174,7 @@ example_selector = LengthBasedExampleSelector(
) )
# We can now use the `example_selector` to create a `FewShotPromptTemplate`. # We can now use the `example_selector` to create a `FewShotPromptTemplate`.
few_shot_prompt = FewShotPromptTemplate( dynamic_prompt = FewShotPromptTemplate(
# We provide an ExampleSelector instead of examples. # We provide an ExampleSelector instead of examples.
example_selector=example_selector, example_selector=example_selector,
example_prompt=example_prompt, example_prompt=example_prompt,
@ -185,7 +185,7 @@ few_shot_prompt = FewShotPromptTemplate(
) )
# We can now generate a prompt using the `format` method. # We can now generate a prompt using the `format` method.
print(few_shot_prompt.format(input="big")) print(dynamic_prompt.format(input="big"))
# -> Give the antonym of every input # -> Give the antonym of every input
# -> # ->
# -> Word: happy # -> Word: happy
@ -224,4 +224,4 @@ print(dynamic_prompt.format(adjective=long_string))
<!-- TODO(shreya): Add correct link here. --> <!-- TODO(shreya): Add correct link here. -->
LangChain comes with a few example selectors that you can use. For more details on how to use them, see [Example Selectors](./examples/example_selectors.ipynb). LangChain comes with a few example selectors that you can use. For more details on how to use them, see [Example Selectors](./examples/example_selectors.ipynb).
You can create custom example selectors that select examples based on any criteria you want. For more details on how to do this, see [Creating a custom example selector](examples/custom_example_selector.ipynb). You can create custom example selectors that select examples based on any criteria you want. For more details on how to do this, see [Creating a custom example selector](examples/custom_example_selector.ipynb).