kumoai.utils.from_relbench#

kumoai.utils.from_relbench(dataset_name)[source]#

Creates a Kumo graph from a RelBench dataset. This function processes the specified RelBench dataset, uploads its tables to the Kumo data plane, and registers them as part of a Kumo graph, including inferred table metadata and edges.

Note

Please note that this method is subject to the limitations for file upload in FileUploadConnector.

import kumoai
from kumoai.utils.datasets import from_relbench

# Assume dataset `example_dataset` in the RelBench repository:
graph = from_relbench(dataset_name="example_dataset")
Parameters:

dataset_name (str) – The name of the RelBench dataset to be processed.

Return type:

Graph

Returns:

A Graph object containing the tables and edges derived from the RelBench dataset.

Raises:

ValueError – If the dataset cannot be retrieved or processed.