Skip to content

Commit

Permalink
Update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
klntsky committed Nov 12, 2024
1 parent 4b035e2 commit 9732b90
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 27 deletions.
26 changes: 24 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
- [Module system](./modules.md)
- [Syntax](./syntax.md)
# Overview

Metaprompt is a language for prompt automation, structuring and reuse.

One one side, it is very similar to a template engine like Jinja or EJS. The twist is, metaprompt expansion depends on LLM outputs of LLM queries, that are formed in natural language.

# Use cases

## Templating

The most basic use case of metaprompt is substituting parameter values instead of variable names embedded in a prompt.

## Prompt organization

A module system and a package system allow anyone to assign identities to promps and package them as callable functions.

## Meta-prompting

Meta-prompting is a technique of asking an LLM to create/modify an LLM prompt.

- Dynamically crafting task-specific prompts based on a set of high level principles
- Modifying prompts to increase accuracy
- Securing inputs from prompt injection attacks
- Selecting the most suitable model based on prompt contents
24 changes: 0 additions & 24 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
@@ -1,24 +0,0 @@
# Overview

Metaprompt is a language for prompt automation, structuring and reuse.

One one side, it is very similar to a template engine like Jinja or EJS. The twist is, metaprompt expansion depends on LLM outputs of LLM queries, that are formed in natural language.

# Use cases

## Prompt organization

A module system and a package system allow anyone to assign identities to promps and package them as callable functions.

## Meta-prompting

Meta-prompting is a technique of asking an LLM to create an LLM prompt.

- Using prompts to craft task-specific prompts based on a set of high level principles
- Modifying prompts to increase accuracy
- Securing inputs from prompt injection attacks
- Model selection based on prompt contents

## Templating

The most basic use case of metaprompt is substituting parameter values instead of variable names embedded in a prompt.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ site_url: "https://docs.metaprompt-lang.org"

# Theme
theme:
name: mkdocs
name: readthedocs

markdown_extensions:
- toc:
Expand Down

0 comments on commit 9732b90

Please sign in to comment.