Skip to main content

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!

Metadata

Release files for foreshadow 0.4.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for foreshadow 0.4.3
File Size Uploaded Provenance Actions
foreshadow-0.4.3.tar.gz 1.1 MB Without provenance Details for foreshadow-0.4.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for foreshadow 0.4.3
File Interpreter ABI Platform Actions
foreshadow-0.4.3-py3-none-any.whl Python 3 none any Details for foreshadow-0.4.3-py3-none-any.whl

Total release size: 2.3 MB

Release files / foreshadow-0.4.3.tar.gz

Download URL foreshadow-0.4.3.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
504a385c28163377b894f20ee228bb602d2f10b21c7776f3f58f0a95ea0767cb
BLAKE2b-256 checksum
How to use checksums
348e078862dd9892eb5700a594abc19741e258aa733e0d9dc5365a50311d39a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/0.12.15 CPython/3.6.8 Darwin/17.7.0

Release files / foreshadow-0.4.3-py3-none-any.whl

Download URL foreshadow-0.4.3-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
55c213092bb2c2082e9e45086b9a977248dc930928c0a66e9ffe8f291e427654
BLAKE2b-256 checksum
How to use checksums
59d283d46e76c83fe592373a009db7ae67e69d18d98842828af3d2f231b43151
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/0.12.15 CPython/3.6.8 Darwin/17.7.0

Security for foreshadow 0.4.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page