Skip to main content

A scikit-learn based AutoML tool

Project description

skplumber

Build Status

A package for automatically sampling, training, and scoring machine learning pipelines on classification or regression problems. The base constructs (pipelines, primitives, etc.) take heavily from the Data Driven Discovery of Models (D3M) core package.

Getting Started

Installation

pip install skplumber

Usage

SKPlumber.crank

The top-level API of the package is the SKPlumber class. You instantiate the class, then use it's crank method to perform a search for an optimal machine learning (ML) pipeline, given your input data x, and y (a pandas.DataFrame and pandas.Series respectively). Here is an example using the classic iris dataset:

from skplumber import SKPlumber
import pandas as pd
from sklearn.datasets import load_iris

dataset = load_iris()
X = pd.DataFrame(data=dataset["data"], columns=dataset["feature_names"])
y = pd.Series(dataset["target"])

plumber = SKPlumber()
best_pipeline, best_score = plumber.crank(X, y, problem="classification")
print(f"The best cross validated score the model found was: {best_score}")

# To use the best pipeline on unseen data:
predictions = best_pipeline.predict(unseen_X)

Pipeline

The Pipeline class is a slightly lower level API for the package that can be used to build, fit, and predict arbitrarily shaped machine learning pipelines. For example, we can create a basic single level stacking pipeline, where the output from predictors are fed into another predictor to ensemble in a learned way:

from skplumber import Pipeline
from skplumber.primitives import transformers, classifiers
import pandas as pd
from sklearn.datasets import load_iris

dataset = load_iris()
X = pd.DataFrame(data=dataset["data"], columns=dataset["feature_names"])
y = pd.Series(dataset["target"])

# A random imputation of missing values step and one hot encoding of
# non-numeric features step are automatically added.
pipeline = Pipeline()
# Preprocess the inputs
pipeline.add_step(transformers["StandardScalerPrimitive"])
# Save the pipeline step index of the preprocessor's outputs
stack_input = pipeline.curr_step_i
# Add three classifiers to the pipeline that all take the
# preprocessor's outputs as inputs
stack_outputs = []
for clf_name in [
    "LinearDiscriminantAnalysisPrimitive",
    "DecisionTreeClassifierPrimitive",
    "KNeighborsClassifierPrimitive"
]:
    pipeline.add_step(classifiers[clf_name], [stack_input])
    stack_outputs.append(pipeline.curr_step_i)
# Add a final classifier that takes the outputs of all the previous
# three classifiers as inputs
pipeline.add_step(classifiers["RandomForestClassifierPrimitive"], stack_outputs)

# Train the pipeline
pipeline.fit(X, y)

# Have fitted pipeline make predictions
pipeline.predict(X)

Package Opinions

  • A pipeline's final step must be the step that produces the pipeline's final output.
  • All missing values are imputed.
  • All columns of type object and category are one hot encoded.

Project details


Download files

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

Source Distribution

skplumber-0.4.7.dev0.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

skplumber-0.4.7.dev0-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file skplumber-0.4.7.dev0.tar.gz.

File metadata

  • Download URL: skplumber-0.4.7.dev0.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.9

File hashes

Hashes for skplumber-0.4.7.dev0.tar.gz
Algorithm Hash digest
SHA256 394c7774c1347bcbc3302658cce0cc103e4377042d058a153490d52b1d6fe0bd
MD5 bf6eaabd903d1a6ecdbaa7e0be917b6c
BLAKE2b-256 2425c498987f34e6aebb33b55aee2db5c579aea6f6f35789c0c53b614d656f74

See more details on using hashes here.

File details

Details for the file skplumber-0.4.7.dev0-py3-none-any.whl.

File metadata

  • Download URL: skplumber-0.4.7.dev0-py3-none-any.whl
  • Upload date:
  • Size: 16.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.9

File hashes

Hashes for skplumber-0.4.7.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 badd2817efc5b6cefd5277892d8609227455a21fffa39d256cb55c70479a0fac
MD5 f159e9b9974886e13c41456b74e6f932
BLAKE2b-256 2c8e0477cc6f4f5d69d20f759aa117c5a509816bf3884b57e75f0aeb6dc6afe5

See more details on using hashes here.

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