Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #39

Merged
merged 1 commit into from
Oct 10, 2023
Merged

Update README.md #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 20 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,26 +49,35 @@ Agent developers often work in the dark, with little to no visibility into agent
## Agent Arena 🥊
(coming soon!)

# Installation & Usage 📘

To start using Agentops SDK, follow these steps:
## Time travel debugging 🔮
(coming soon!)

1. Clone the GitHub repo:
# Installation & Usage 📘

```bash
git clone https://github.com/AgentOps-AI/agentops.git
pip install agentops
```

2. Install the requirements:
## Analytics in 3 lines of code:

```bash
pip install -e agentops/
Initialize the AgentOps client, and automatically get analytics on every LLM call you make.

```python python
import openai # Make sure openai is imported before instantiating an AgentOps client.
import agentops

# Beginning of program's code (i.e. main.py, __init__.py)
ao_client = agentops.Client(<INSERT YOUR API KEY HERE>)

...
# End of program
ao_client.end_session('Success')
```

3. Integrate the SDK into your AI agent application. Refer to our [API documentation](http://docs.agentops.ai) for detailed instructions.
Refer to our [API documentation](http://docs.agentops.ai) for detailed instructions.

# Join the Revolution 🎉

Is there a feature you'd like to see agenotps cover? Just raise it in the issues tab, and we'll work on adding it the roadmap.
Is there a feature you'd like to see AgentOps cover? Just raise it in the issues tab, and we'll work on adding it to the roadmap.

We're on a mission to improve AI agents, and we want you to be a part of it. Start building your next agent with agentops SDK today!
We're on a mission to improve AI agents, and we want you to be a part of it. Start building your next agent with Agent SDK today!