Skip to content

Commit

Permalink
readme update (#34)
Browse files Browse the repository at this point in the history
* Update README.md
  • Loading branch information
vijayc9 authored Oct 14, 2024
1 parent 752d9fe commit 85dbef6
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 5 deletions.
50 changes: 45 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# AgentNeo
# AgentNeo


**Empower Your AI Applications with Unparalleled Observability and Optimization**

AgentNeo is an advanced, open-source **Agentic AI Application Observability, Monitoring, and Evaluation Framework**. Designed to elevate your AI development experience, AgentNeo provides deep insights into your AI agents, Large Language Model (LLM) calls, and tool interactions. By leveraging AgentNeo, you can build more efficient, cost-effective, and high-quality AI-driven solutions.

![AgentNeo Dashboard](docs/assets/dashboard.png)
![AgentNeo Overview](docs/assets/overview1.png)


Whether you're a seasoned AI developer or just starting out, AgentNeo offers robust logging, visualization, and evaluation capabilities to help you debug and optimize your applications with ease.

Expand Down Expand Up @@ -64,7 +66,7 @@ Get up and running with AgentNeo in just a few steps!
### 1. Import the Necessary Components

```python
from agentneo import AgentNeo, Tracer, Evaluation, launch_dashboard
from agentneo import AgentNeo, Tracer, Evaluation, launch_dashboard, Execution
```

### 2. Create a Session and Project
Expand All @@ -77,7 +79,7 @@ neo_session.create_project(project_name="my_project")
### 3. Initialize the Tracer

```python
tracer = Tracer(session=neo_session, log_file_path="trace.json")
tracer = Tracer(session=neo_session)
tracer.start()
```

Expand All @@ -102,7 +104,22 @@ def my_agent_function():
pass
```

### 5. Stop Tracing and Launch the Dashboard
### 5. Evaluate your AI Agent's performance

```python
exe = Execution(session=neo_session, trace_id=1)

# run a single metric
exe.execute(metric_list=['metric_name'])
```

```python
# get your evaluated metrics results
metric_results = exe.get_results()
print(metric_results)
```

### 6. Stop Tracing and Launch the Dashboard

```python
tracer.stop()
Expand All @@ -112,6 +129,8 @@ launch_dashboard(port=3000)

Access the interactive dashboard by visiting `http://localhost:3000` in your web browser.

![AgentNeo Evaluation](docs/assets/evaluation1.png)

## 🔧 Advanced Usage

### Project Management
Expand All @@ -130,6 +149,23 @@ Manage multiple projects with ease.
neo_session.connect_project(project_name="existing_project")
```

### Metrics Evaluation
#### Supported Metrics
1. Goal Decomposition Efficiency ([goal_decomposition_efficiency](https://docs.raga.ai/agentneo/metric-library/goal-decomposition-efficiency))
2. Goal Fulfillment Rate (goal_fulfillment_rate)
3. Tool Correctness Metric (tool_correctness_metric)
4. Tool Call Success Rate Metric (tool_call_success_rate_metric)

- **Run multiple metrics together**
```python
exe.execute(metric_list=['metric_name1', 'metric_name2', ..])
```

- **Use your own config and metadata related to the metric**
```python
exe.execute(metric_list=['metric_name'], config={}, metadata={})
```

### Execution Graph Visualization

AgentNeo generates an execution graph that visualizes the flow of your AI application, including LLM calls, tool usage, and agent interactions. Explore this graph in the interactive dashboard to gain deeper insights.
Expand All @@ -145,6 +181,10 @@ The AgentNeo dashboard offers a comprehensive view of your AI application's perf
- **Execution Graph Visualization**
- **Timeline of Events**


![AgentNeo Analysis](docs/assets/analysis1.png)


### Launching the Dashboard

```python
Expand Down
Binary file added docs/assets/analysis1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/dashboard.png
Binary file not shown.
Binary file added docs/assets/evaluation1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/overview1.png
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 85dbef6

Please sign in to comment.