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.6.tar.gz (37.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mondobrain-0.1.6-py3-none-any.whl (192.7 kB view details)

Uploaded Python 3

File details

Details for the file mondobrain-0.1.6.tar.gz.

File metadata

  • Download URL: mondobrain-0.1.6.tar.gz
  • Upload date:
  • Size: 37.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.6.13

File hashes

Hashes for mondobrain-0.1.6.tar.gz
Algorithm Hash digest
SHA256 0b0569d69cf0619b2e9e3744d0b0ba3932a32517c7a79eba075b8920a72fea6d
MD5 4e3bdd34bdbd3437d9a84bd764730e8e
BLAKE2b-256 082298857ef0247c9a37a487d4a6313b1c3b9acdac26081651cf5bd22b34584d

See more details on using hashes here.

File details

Details for the file mondobrain-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: mondobrain-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 192.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.6.13

File hashes

Hashes for mondobrain-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a1ee8c92293cf67faeac4cd259ed51a799292b3723fe15f96b621f088a9c5f83
MD5 189059399dc277233f3cf5b41bcf7914
BLAKE2b-256 888e93b40498db81d824f80cd1f1e7c1b5a182743da56aa52c9b185c039006ff

See more details on using hashes here.

Supported by

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