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

Uploaded Source

Built Distribution

foreshadow-0.2.1-py3-none-any.whl (231.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: foreshadow-0.2.1.tar.gz
  • Upload date:
  • Size: 171.0 kB
  • 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.2.1.tar.gz
Algorithm Hash digest
SHA256 5fc78cc29fcacf7853942ee4640bd2e2060cf98a65cead66645856f53c140509
MD5 535eaf2928e802c6db3c07869110f8b1
BLAKE2b-256 65fc5647e9f8e67927449724d5049f7785457e5d19146dafa841f1fd130c4e8b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: foreshadow-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 231.5 kB
  • 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f04383ef0bac6a351967edb81cc73cf45fcc99df4c468eac1910326ec1f7b5c6
MD5 712688537916874e079f1039f1aacf30
BLAKE2b-256 3f93704d2bcd7702d90e659f3b73b30ba2c7756adddadda324c231df1dbed364

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