Quickstart: KumoRFM

View as Markdown

In this guide, we walk you through an end-to-end example using a multi-table E-Commerce dataset. You’ll learn how to load data, auto-infer a relational graph, and run instant predictions: demand forecasting, churn prediction, item recommendations, and missing value imputation, all without training a model.

Step 1: Install the SDK

Install the Python SDK

1pip install kumoai

Step 2: Get an API key

You need an API key to make calls to KumoRFM. Use the API key and API URL provided for your KumoRFM environment.

Step 3: Initialize a client

Use your API key to initialize a Kumo client:

1import kumoai.rfm as rfm, os
2
3os.environ["KUMO_API_KEY"] = "ENTER_YOUR_API_KEY_HERE"
4
5rfm.init()

Step 4: Import your data

We will use an E-Commerce dataset for this example:

1import pandas as pd
2
3dataset_url = "s3://kumo-sdk-public/rfm-datasets/online-shopping"
4
5users_df = pd.read_parquet(f"{dataset_url}/users.parquet")
6items_df = pd.read_parquet(f"{dataset_url}/items.parquet")
7orders_df = pd.read_parquet(f"{dataset_url}/orders.parquet")

Step 5: Create a graph

Auto infer links between tables to form a graph

1graph = rfm.Graph.from_data({
2 "users": users_df,
3 "items": items_df,
4 "orders": orders_df,
5})
6
7# Inspect the graph - requires graphviz to be installed
8graph.visualize()

Step 6: Make a prediction

Write a predictive query to generate instant predictions:

1model = rfm.KumoRFM(graph)
2
3# Forecast 30-day product demand
4query1 = "PREDICT SUM(orders.price, 0, 30, days) FOR items.item_id=1"
5result1 = model.predict(query1)
6display(result1)
7
8# Predict customer churn
9query2 = "PREDICT COUNT(orders.*, 0, 90, days)=0 FOR users.user_id IN (42, 123)"
10result2 = model.predict(query2)
11display(result2)
12
13# Item recommendation
14query3 = "PREDICT LIST_DISTINCT(orders.item_id, 0, 30, days) RANK TOP 10 FOR users.user_id=123"
15result3 = model.predict(query3)
16display(result3)
17
18# Missing value imputation
19query4 = "PREDICT users.age FOR users.user_id=8"
20result4 = model.predict(query4)
21display(result4)

Notebooks

Explore practical examples and use cases through our interactive notebooks.

Quickstart

Use KumoRFM for instant predictions using your own dataset with no model training required.

KumoRFM · pandas

E-commerce Agent

Build an e-commerce agent that identifies churn risk, predicts probabilities, and generates re-engagement emails.

KumoRFM · CrewAI · OpenAI · MCP

Sales Agent

Build a sales agent for lead scoring that identifies high-value prospects and creates prioritized outreach lists.

KumoRFM · OpenAI Agents SDK · MCP

Insurance Agent

Build an insurance agent that predicts policy expiration risks, recommends bundling, and generates retention emails.

KumoRFM · LangGraph · Anthropic · MCP

Handbook

Comprehensive guide showing graph schema definition, predictive queries, and model evaluation using Formula 1 data.

KumoRFM · RelBench · scikit-learn

Hands-on Tutorial

Interactive tutorial demonstrating predictive analytics on multi-table datasets using Super Mario Maker game data.

KumoRFM · pandas

Predictive Query Language

Learn PQL to frame entire ML tasks in SQL-like statements using the Steam gaming dataset.

KumoRFM · PQL

RelBench Evaluation

Step-by-step guide for evaluating KumoRFM performance on custom datasets using rel-bench.

KumoRFM · RelBench · scikit-learn

SALT Dataset

Advanced evaluation on complex enterprise ERP dataset for multi-class classification.

KumoRFM · Hugging Face · datasets

Single Table Classification

Demonstrates binary classification on single tabular data using the scikit-learn breast cancer dataset.

KumoRFM · scikit-learn · NumPy