Skip to main content

MondoBrain API wrapper

Reason this release was yanked:

mondobrain is no longer maintained. Please use datawhys instead: https://pypi.org/project/datawhys/

Project description

MondoBrain Python SDK

MondoBrain Python SDK is a python wrapper for the MondoBrain API that provides additional functionality such as dataframe ingest and one-off processing

Installation

Use the package manager pip to install mondobrain.

pip install mondobrain

Dependencies

Install from source

In the mondobrain-python directory (same directory as this README.md file), run this command in your terminal:

pip install -e .

Usage

import mondobrain as mb

# Set your credentials
mb.api_key = "<API-KEY>"
mb.api_secret = "<API-SECRET>"

# Build a pandas dataframe and store in `df` (not shown)

# Convert your pandas df to a mondobrain df
mdf = mb.MondoDataFrame(df)

# Select a column as your outcome column & specify a target class
outcome = mdf["column_name"]

# for a discrete column
outcome.target_class = "Some_modality"

# for a continuous column the value should be `min` or `max`
outcome.target_class = "max"

# Get a dataframe of all columns you want to explor
explorable = mdf[["column_a", "column_b"]]

# Create a solver instance
solver = mb.Solver()

# Fit your data
solver.fit(explorable, outcome)

# Check your results
solver.rule

See documentation and SDK Example.ipynb in the mondobrain-python directory for more in depth examples.

The package includes documentation to provide explanation and examples of usage.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Take a look at CONTRIBUTING.md for more info

Please make sure to update tests as appropriate.

License

MIT

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mondobrain-0.1.5.tar.gz (36.5 kB view hashes)

Uploaded Source

Built Distribution

mondobrain-0.1.5-py3-none-any.whl (190.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page