Install¶
Featuretools is available for Python 3.6, 3.7, and 3.8. The recommended way to install Featuretools is using pip
or conda
:
python -m pip install featuretools
or from the Conda-forge channel on anaconda.org:
conda install -c conda-forge featuretools
Add-ons¶
You can install add-ons individually or all at once by running:
python -m pip install featuretools[complete]
- Update checker:
Receive automatic notifications of new Featuretools releases:
python -m pip install featuretools[update_checker]
- TSFresh Primitives:
Use 60+ primitives from tsfresh in Featuretools:
python -m pip install featuretools[tsfresh]
- Categorical Encoding:
Encode categorical data for integration into Featuretools/machine learning workflows:
python -m pip install featuretools[categorical_encoding]
- NLP Primitives:
Use Natural Language Processing Primitives for data with text in Featuretools:
python -m pip install featuretools[nlp_primitives]
- AutoNormalize:
Automated creation of normalized
EntitySet
from denormalized data:python -m pip install featuretools[autonormalize]
- Featuretools Sklearn Transformer:
Deep Feature Synthesis as a scikit-learn pipelines transformer
python -m pip install featuretools[sklearn_transformer]
Installing Graphviz¶
In order to use EntitySet.plot
you will need to install the graphviz library.
Conda users:
conda install python-graphviz
Ubuntu:
sudo apt-get install graphviz
pip install graphviz
Mac OS:
brew install graphviz
pip install graphviz
Windows:
conda install python-graphviz
Install from Source¶
To install featuretools from source, clone the repository from github:
git clone https://github.com/FeatureLabs/featuretools.git
cd featuretools
python setup.py install
or use pip
locally if you want to install all dependencies as well:
pip install .
You can view the list of all dependencies within the extras_require
field
of setup.py
.
Development¶
Before making contributing to the codebase, please follow the guidelines here
Test¶
Note
In order to the run the featuretools tests you will need to have graphviz installed as described above.
Run featuretools tests:
make test
Before committing make sure to run linting in order to pass CI:
make lint
Some linting errors can be automatically fixed by running the command below:
make lint-fix
Build Documentation¶
Build the docs with the commands below:
cd docs/
# small changes
make html
# rebuild from scatch
make clean html
Note
The Featuretools library must be import-able to build the docs.