Quick Start

This guide will walk you through setting up Ryoma and start coding with Ryoma.

Prerequisites

Before you start, make sure you have the following installed:

  • Python 3.9 or higher

Installation

To install Ryoma, run the following command:

pip install ryoma_ai

Getting Started

To start using Ryoma, you can run the following code:


from ryoma_ai.agent.pandas import PandasAgent
import pandas as pd

df = pd.DataFrame({
    'customer_id': [1, 2, 3, 4, 5],
    'purchase_amount': [100, 200, 300, 400, 500]
})
pandas_agent = PandasAgent("gpt-3.5-turbo")
    .add_dataframe(df)

print(pandas_agent.stream("I want to get the top customer which making the most purchases"))

This code will create a new agent that uses the GPT-3.5-turbo model and has a confidence threshold of 0.8.

Next Steps

Now that you have successfully set up Ryoma, you can start exploring more features and functionalities. Check out the documentation for more information.