mostlyai 0.3.5

The official Python client for the MOSTLY AI platform.

MOSTLY AI - GenAI for Tabular Data

A Python wrapper for the MOSTLY AI platform (https://app.mostly.ai/).

Intent	Primitive
Train a Generative AI on tabular data	g = mostly.train(data)
Empower your team with safe synthetic data	mostly.share(g, email)
Generate unlimited synthetic data on demand	mostly.generate(g, size)
Prompt the generator for the data that you need	mostly.generate(g, seed)
Connect to any data source within your org	mostly.connect(config)
Info about the current user	mostly.me()

Installation

pip install mostlyai

Basic Usage

from mostlyai import MostlyAI
mostly = MostlyAI(api_key='your_api_key') 
g = mostly.train(data)      # train a generator on your data
sd = mostly.generate(g)     # generate a synthetic dataset
syn = sd.data()             # consume synthetic as pd.DataFrame

Supported Methods

Connectors

c = mostly.connect(config)

c = mostly.connectors.create(config)
c = mostly.connectors.get(id)
it = mostly.connectors.list()
c = c.update(config)
ls = c.locations(prefix)
config = c.config()
c.open()
c.reload()
c.delete()

Generators

g = mostly.train(data, config, name, start=True, wait=True)

g = mostly.generators.create(config)
g = mostly.generators.get(id)
it = mostly.generators.list()
g = g.update(config)
config = g.config()
g.open()
g.reload()
g.delete()

g.training.start()
g.training.progress()
g.training.cancel()
g.training.wait()

Synthetic Datasets

sd = mostly.generate(g, seed=seed)
sd = mostly.generate(g, size=size)
sd = mostly.generate(g, config=config)

sd = mostly.synthetic_datasets.create(g, config)
sd = mostly.synthetic_datasets.get(id)
it = mostly.synthetic_datasets.list()
config = sd.config()
sd.open()
sd.reload()
sd.delete()


sd.generation.start()
sd.generation.progress()
sd.generation.cancel()
sd.generation.wait()

sd.data()
sd.download(file, format)

Sharing

mostly.share(g | sd | c, email)
mostly.unshare(g | sd | c, email)

g.shares()
sd.shares()
c.shares()