Skip to content

Commit

Permalink
Merge pull request #2028 from Agenta-AI/doc/fix-broken-components
Browse files Browse the repository at this point in the history
Doc: fixed heading wrong placement
  • Loading branch information
mmabrouk authored Aug 27, 2024
2 parents fcf2ee9 + 078f694 commit a286217
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions website/docs/evaluation/test_sets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: "Test Sets"
---

# Creating a Test Set

This guide will help you create, edit, and use test sets effectively.

Test sets in Agenta can be loaded in the playground, used in evaluations, or for conducting human evaluations/annotations.

# Creating a Test Set

You can create a test set in Agenta using various methods: the API, the UI, by uploading a CSV, or directly from the playground.

## Creating a Test Set from the Playground
Expand Down
4 changes: 2 additions & 2 deletions website/docs/observability/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Quick Start
---

# Setting up telemetry

You can configure Agenta to capture all inputs, outputs, and other metadata from your LLM applications, regardless of whether they are hosted in Agenta or in your environment.

Post instrumentation, Agenta provides a dashboard that offers an overview of your app's performance metrics over time, including request counts, average latency, and costs.
Expand All @@ -17,8 +19,6 @@ Concepts of Telemetry:

:::

# Setting up telemetry

:::note
When creating an application from the UI, tracing is enabled by default. No
setup is required. Simply navigate to the observability view to see all
Expand Down
4 changes: 2 additions & 2 deletions website/docs/prompt_management/integrating.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Applications and prompts created in agenta can be integrated into your projects

1. **As a Prompt Management System:** Fetch the latest version of prompts/configurations from agenta.

<img width="420px" src="/images/prompt_management/asapromptmanagement.png" />
<img width="420px" class="bg-white" src="/images/prompt_management/asapromptmanagement.png" />

2. **As a Middleware:** Use the applications hosted on agenta directly.

<img width="420px" src="/images/prompt_management/asaproxy.png" />
<img width="420px" class="bg-white" src="/images/prompt_management/asaproxy.png" />

## Using agenta as Middleware

Expand Down
4 changes: 2 additions & 2 deletions website/docs/reference/cli/core_commands/init.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: "agenta init"
description: "Initialize a new project"
---

# Description

```bash
agenta init
```

# Description

The init command initializes a new agenta project. Users can define the application's name and select the agenta platform host (either local or cloud).

This command creates a blank project in the backend and generates a config.toml file for configuration settings.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/reference/cli/core_commands/variant_list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: "agenta variant list"
description: "List the variants for an application"
---

# Description

```bash
agenta variant list
```

# Description

The `list` command displays all the variants of your app that are currently available in the backend.

:::caution
Expand Down
4 changes: 2 additions & 2 deletions website/docs/reference/cli/core_commands/variant_remove.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: "agenta variant remove"
description: "Removes a variant from an app/project"
---

# Description

```bash
agenta variant remove
```

# Description

`variant remove` removes a variant from an app/project. It is called without any argument. The list of variants in the app/project is displayed and the user is prompted to select one of them to remove.

:::caution
Expand Down
4 changes: 2 additions & 2 deletions website/docs/reference/cli/core_commands/variant_serve.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: "agenta variant serve"
description: "Serve an application to the agenta platform"
---

# Description

```bash
agenta variant serve app_name.py
```

# Description

The `serve` command deploys the code of an app to the agenta platform. The command packages the code in the .py file along with any additional files in the same directory and deploy them on the agenta platform. Once deployed, the variant becomes accessible the web UI. It can ehtn be further deployed to a staging or production environment as an API endpoint.

In the agenta UI, the deployed variant is initially named `app_name.default` where `app_name` is the name of the python file deployed and `default` the default configuration. Creating a new configuration `someconfig` (either from the UI or from CLI), will result in the creation of corresponding new variant, named `app_name.someconfig`.
Expand Down

0 comments on commit a286217

Please sign in to comment.