DataWhys API wrapper
Project description
DataWhys Python SDK
DataWhys Python SDK is a python wrapper for the DataWhys API that provides additional functionality such as dataframe ingest and one-off processing
Installation
Use the package manager pip to install datawhys.
pip install datawhys
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 datawhys as dw
# Set your credentials
dw.api_key = "<API-KEY>"
# Build a pandas dataframe and store in `df` (not shown)
# Convert your pandas df to a datawhys df
dwf = dw.DataWhysFrame(df)
# Select a column as your outcome column & specify a target class
outcome = dwf["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 = dwf[["column_a", "column_b"]]
# Create a solver instance
solver = dw.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
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
Built Distribution
File details
Details for the file datawhys-0.4.1.tar.gz
.
File metadata
- Download URL: datawhys-0.4.1.tar.gz
- Upload date:
- Size: 44.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.63.0 importlib-metadata/4.8.3 keyring/21.8.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b592a8df37cb52e72ad1032035a31f8019df36cef8e4608b7933810b9478aafd |
|
MD5 | 004beaf4af2affdc2cf7e9a489c7a485 |
|
BLAKE2b-256 | 5c047e0097ce7c29914a2d51d81545470ce8a43259d18400cd6eedc2eed408de |
File details
Details for the file datawhys-0.4.1-py3-none-any.whl
.
File metadata
- Download URL: datawhys-0.4.1-py3-none-any.whl
- Upload date:
- Size: 200.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.63.0 importlib-metadata/4.8.3 keyring/21.8.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40b3f534ea8c9e5a43193f671d5699b537cb758e078a8ec40f43f9688bf9ad67 |
|
MD5 | 57c3b2248c69ceb9906f6c66f348e52b |
|
BLAKE2b-256 | 22e4c46441044c8b382a17fb21466d9b4024669733932159579ad4236d0134b7 |