Skip to content

Commit

Permalink
docs(app): AGE-870 updated images
Browse files Browse the repository at this point in the history
  • Loading branch information
mmabrouk committed Oct 9, 2024
1 parent 8da1a84 commit 56ae131
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 10 deletions.
6 changes: 4 additions & 2 deletions docs/docs/prompt-management/01-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ import clsx from 'clsx';
Building LLM-powered applications is an iterative process. In each iteration, you aim to improve the application's performance by refining prompts, adjusting configurations, and evaluating outputs.

<img
style={{ width: "75%", display: "block", margin: "0 auto" }}
src="/images/prompt_management/llm_lifecycle.png"
style={{ display: "block", margin: "10 auto" }}
src="/images/prompt_management/illustration-llmops.png"
alt="Illustration of the LLMOPs process"
loading="lazy"
/>

A prompt management system provides you the tools to do this process systematically by:
Expand Down
20 changes: 12 additions & 8 deletions docs/docs/prompt-management/07-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ title: "Core Concepts"
Below are the description to the main terms and concepts used in agenta.

<img
style={{ width: "75%", display: "block", margin: "0 auto" }}
src="/images/prompt_management/taxonomy_agenta.png"
style={{ display: "block", margin: "0 auto" }}
src="/images/prompt_management/taxonomy-concepts.png"
alt="Taxonomy of concepts in Agenta"
loading="lazy"
/>

### Templates
Expand All @@ -22,7 +24,7 @@ Agenta also allows you to create custom templates for your workflows using our S
- Chains of Multiple Prompts
- Agents Interacting with External APIs

After creating a template, you can interact with it in the playground, run no-code evaluations, and publish versions all from the webUI.
After creating a template, you can interact with it in the playground, run no-code evaluations, and deploy versions all from the web UI.

### Applications

Expand All @@ -43,16 +45,18 @@ Within each application, you can create **variants**. **Variants** are different

Every **variant** is **versioned** and immutable. When you make changes to a **variant**, a new **version** is created. Each **version** has a **commit id** that uniquely identifies it.

### Endpoints
### Environments

**Endpoints** are the interfaces where your published variants are accessible. You can publish a **version** of a **variant** to an **endpoint**. Each **endpoint** has a user-defined environment name (e.g. development, staging, production) that specifies its context or stage.
**Environments** are the interfaces where your deployed variants are accessible. You can deploy a **version** of a **variant** to an **environment**. Each **environment** has a user-defined environment name (e.g. development, staging, production) that specifies its context or stage.

You can then integrate the **endpoint** into your codebase to fetch the configuration published on that **endpoint**. Additionally, you can directly call the **endpoint** containing the application running with that configuration.
You can then integrate the **environment** into your codebase to fetch the configuration deployed on that **environment**. Additionally, you can directly invoke the endpoints relating to the **environment** containing the application running with that configuration.

By default, applications come with three predefined environment names for **endpoints**:
By default, applications come with three predefined **environments**:

- **Development:** For initial testing and experimentation.
- **Staging:** For pre-production testing and quality assurance.
- **Production:** For live use with real users.

When publishing a **variant** to an **endpoint**, the latest **version** of that **variant** gets published. Each **endpoint** points to a specific **version** of a **variant** (a certain **commit**). Updating the **variant** after publishing does not automatically update the **endpoint**.
:::warning
When deploying a **variant** to an **environment**, the latest **version** of that **variant** gets deployed. Each **environment** points to a specific **version** of a **variant** (a certain **commit**). Updating the **variant** after deploying does not automatically update the **environment**.
:::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 56ae131

Please sign in to comment.