Skip to main content

Peer into the future of a data science project

Project description

BuildStatus Documentation Status Coverage Code Style License

Foreshadow is an automatic pipeline generation tool that makes creating, iterating, and evaluating machine learning pipelines a fast and intuitive experience allowing data scientists to spend more time on data science and less time on code.

Installing Foreshadow

$ pip install foreshadow

Read the documentation to set up the project from source.

Getting Started

To get started with foreshadow, install the package using pip install. This will also install the dependencies. Now create a simple python script that uses all the defaults with Foreshadow.

First import foreshadow

import foreshadow as fs

Also import sklearn, pandas, and numpy for the demo

import pandas as pd

from sklearn.datasets import boston_housing
from sklearn.model_selection import train_test_split

Now load in the boston housing dataset from sklearn into pandas dataframes. This is a common dataset for testing machine learning models and comes built in to scikit-learn.

boston = load_boston()
bostonX_df = pd.DataFrame(boston.data, columns=boston.feature_names)
bostony_df = pd.DataFrame(boston.target, columns=['target'])

Next, exactly as if working with an sklearn estimator, perform a train test split on the data and pass the train data into the fit function of a new Foreshadow object

X_train, X_test, y_train, y_test = train_test_split(bostonX_df,
   bostony_df, test_size=0.2)
shadow = fs.Foreshadow()
shadow.fit(X_train, y_train)

Now fs is a fit Foreshadow object for which all feature engineering has been performed and the estimator has been trained and optimized. It is now possible to utilize this exactly as a fit sklearn estimator to make predictions.

shadow.score(X_test, y_test)

Great, you now have a working Foreshaow installation! Keep reading to learn how to export, modify and construct pipelines of your own.

Key Features

  • Automatic Feature Engineering

  • Automatic Model Selection

  • Rapid Pipeline Development / Iteration

  • Automatic Parameter Optimization

  • Ease of Extensibility

  • Scikit-Learn Compatible

Foreshadow supports python 3.6+

Documentation

Read the docs!

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

foreshadow-0.4.4.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

foreshadow-0.4.4-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file foreshadow-0.4.4.tar.gz.

File metadata

  • Download URL: foreshadow-0.4.4.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.15 CPython/3.6.8 Darwin/17.7.0

File hashes

Hashes for foreshadow-0.4.4.tar.gz
Algorithm Hash digest
SHA256 655325a290deb453b19879f5b2cf95ff14437ce985d177b85d93562a64f6c227
MD5 af41f4f3eab8de905b1e4b3fb67614a1
BLAKE2b-256 4f5849007d9f5d4a7b13367777ce3ac641b7b37a8f28e22874f2e0a6eb3317eb

See more details on using hashes here.

File details

Details for the file foreshadow-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: foreshadow-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.15 CPython/3.6.8 Darwin/17.7.0

File hashes

Hashes for foreshadow-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3bd9653cdf8fdd7ae93f1d9c7c1419c5cd4bc65acfbfb7be6dc91ddb629b4c97
MD5 327d949da0f1ab5286631c6e1a54634e
BLAKE2b-256 6043a599427bdba485e10aa4cec16aab368321cb59b14d5c4137b031df832320

See more details on using hashes here.

Supported by

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