datawhys-sdk 0.5.5

DataWhys API wrapper

DataWhys Python SDK

DataWhys Python SDK is a Python wrapper for the DataWhys API that handles data orchestration, cloud uploads, and solver execution.

Installation

Use the package manager pip to install.

pip install datawhys-sdk

Usage

import datawhys as dw
from datawhys.datasets import load_titanic

# 1. Set your credentials
dw.api_key = "<YOUR_API_KEY>"

# Optional: Set custom API base
# dw.api_base = "https://your-api-server.com/api/v1"

# 2. Load and Upload your data
# DataWhys uses a cloud-first workflow: upload once, solve many times.
dwf = load_titanic()
dwf.upload()

print(f"File ID: {dwf.file_id}")

# 3. Create a solver and fit the data
solver = dw.Solver()

# Pass the DataWhysFrame directly. The solver extracts the cloud file_id automatically.
solver.fit(
    dwf=dwf,
    outcome='survived',
    target='Died',
    features=['sex', 'class', 'age', 'fare']
)

# 4. View results
print(solver.rule)
print('Score:', solver.score)
print('Rule Size:', solver.size)

# Filter the original dataframe using the discovered rule
filtered_df = solver.get_rule_data()

See the SDK Example.ipynb for more in-depth examples and advanced features.

Install from source

git clone https://github.com/datawhys/datawhys-python-sdk.git
cd datawhys-python-sdk
pip install -e .

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