Skip to content

Commit

Permalink
v0.1.1 Update (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrislott authored Sep 26, 2024
2 parents b4aa6bf + 96d7d4c commit 2e5d4eb
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This code is reusable across applications.
- **STT (Speech-to-Text)**: Converts audio to text.
- **TTS (Text-to-Speech)**: Converts text to audio.
- **React xRx Client Library**: Reusable UI components and utilities.
- **Agent Framework**: Foundation for building reasoning agents.
- **xRx Agent Framework**: Foundation for building reasoning agents.
- **Guardrails Proxy**: A safety layer for the reasoning system.

These components then communicate via the following sequence diagram
Expand Down
4 changes: 2 additions & 2 deletions docs/content/how-it-works/api_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ The xRx Core contains the essential components that form the foundation of the x
- #### React xRx Client Library
**[Library]** A reusable React library that provides UI components and utilities for building the front-end of xRx-powered applications. It can be imported into each specific app to streamline development.

- #### Agent Framework
- #### xRx Agent Framework
**[Library]** A reusable library that provides the foundation for building reasoning agents. It includes common functionalities and structures that can be extended and customized for specific application needs.

These components are either containerized modules (like TTS, STT, Orchestrator) defined as separate Docker containers, or reusable libraries (like react-xrx-client and agent_framework) that can be imported into specific applications. This modular structure allows developers to easily customize and extend xRx for their specific needs while benefiting from a solid, tested foundation.
These components are either containerized modules (like TTS, STT, Orchestrator) defined as separate Docker containers, or reusable libraries (like react-xrx-client and xrx_agent_framework) that can be imported into specific applications. This modular structure allows developers to easily customize and extend xRx for their specific needs while benefiting from a solid, tested foundation.

## Communication Flow

Expand Down
2 changes: 1 addition & 1 deletion docs/content/tutorials/bring_your_own_reasoning_agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Let's walk through the process of creating a custom tool, using a simple calcula
First, we'll create the tool function:

```python
from agent_framework import observability_decorator
from xrx_agent_framework import observability_decorator

@observability_decorator(name="calculator")
def calculator(operation: str, x: float, y: float) -> str:
Expand Down
6 changes: 3 additions & 3 deletions xrx_agent_framework/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Agent Framework
# xRx Agent Framework

## Introduction

The Agent Framework is a library designed to facilitate and abstract the infrastructure outside of application-specific code in the xRx system. It provides a set of tools and utilities that streamline the development of reasoning agents, allowing developers to focus on the core logic of their applications.
The xRx Agent Framework is a library designed to facilitate and abstract the infrastructure outside of application-specific code in the xRx system. It provides a set of tools and utilities that streamline the development of reasoning agents, allowing developers to focus on the core logic of their applications.

## Features

Expand All @@ -13,7 +13,7 @@ The Agent Framework is a library designed to facilitate and abstract the infrast

## Installation

The Agent Framework is part of the xRx-core submodule submodule. Installation is automatic when you install the xRx-core submodule.
The xRx Agent Framework is part of the xRx-core submodule submodule. Installation is automatic when you install the xRx-core submodule.


## Contributing
Expand Down
2 changes: 1 addition & 1 deletion xrx_agent_framework/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools.packages]
find = {include = ["agent_framework*"]}
find = {include = ["xrx_agent_framework*"]}

0 comments on commit 2e5d4eb

Please sign in to comment.