Doc Error: modify part 2 of advanced prompts

[amanyara]

Description

When I run the second part - "Prompt Template Variable Mappings" in advanced_prompts.ipynb as pictures below.

The code in that example as follows:

# NOTE: here notice we use `my_context` and `my_query` as template variables

qa_prompt_tmpl_str = """\
Context information is below.
---------------------
{my_context}
---------------------
Given the context information and not prior knowledge, answer the query.
Query: {my_query}
Answer: \
"""

template_var_mappings = {"context_str": "my_context", "query_str": "my_query"}

prompt_tmpl = PromptTemplate(
    qa_prompt_tmpl_str, template_var_mappings=template_var_mappings
)

fmt_prompt = partial_prompt_tmpl.format(
    context_str="In this work, we develop and release Llama 2, a collection of pretrained and fine-tuned large language models (LLMs) ranging in scale from 7 billion to 70 billion parameters",
    query_str="How many params does llama 2 have",
)
print(fmt_prompt)

The example explains how Prompt Template Variable Mappings works, but it use the variable partial_prompt_tmpl which belongs to the 1st example Partial Formatting. Although it runs without errors, the result is different and doesn't show the function of Prompt Template Variable Mappings.

The code template_var_mappings = {"context_str": "my_context", "query_str": "my_query"} makes a variable changes in format() with the help of Prompt Template Variable Mappings. It uses variable partial_prompt_tmpl which doesn't contain "my_context" and "my_query" !

I changed the variable partial_prompt_tmpl to prompt_tmpl and fully introduce the fuction of Prompt Template Variable Mappings.

New Package?

Did I fill in the tool.llamahub section in the pyproject.toml and provide a detailed README.md for my new integration or package?

• Yes
• No

Version Bump?

Did I bump the version in the pyproject.toml file of the package I am updating? (Except for the llama-index-core package)

• Yes
• No

Type of Change

Please delete options that are not relevant.

• This change requires a documentation update

How Has This Been Tested?

Your pull-request will likely not be merged unless it is covered by some form of impactful unit testing.

• I believe this change is already covered by existing unit tests

Suggested Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added Google Colab support for the newly added notebooks.
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• I ran make format; make lint to appease the lint gods

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[masci]

Good catch, thank you!