lore 0.8.6
a framework for building and using data science
License: MIT
Requires Python: >=3.0, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <4
Keywords: machine learning framework tensorflow airflow

.. role:: python(code)
   :language: python

.. role:: bash(code)
   :language: bash

======
 Lore
======

|docs| |pypi| |circleci| |mit|

Lore is a python framework to make machine learning approachable for Engineers and maintainable for Data Scientists.

Features
--------

- Models support hyper parameter search over estimators with a data pipeline. They will efficiently utilize multiple GPUs (if available) with a couple different strategies, and can be saved and distributed for horizontal scalability.
- Estimators from multiple packages are supported: `Keras <https://keras.io/>`_ (TensorFlow/Theano/CNTK), `XGBoost <https://xgboost.readthedocs.io/>`_ and `SciKit Learn <http://scikit-learn.org/stable/>`_. They can all be subclassed with build, fit or predict overridden to completely customize your algorithm and architecture, while still benefiting from everything else.
- Pipelines avoid information leaks between train and test sets, and one pipeline allows experimentation with many different estimators. A disk based pipeline is available if you exceed your machines available RAM.
- Transformers standardize advanced feature engineering. For example, convert an American first name to its statistical age or gender using US Census data. Extract the geographic area code from a free form phone number string. Common date, time and string operations are supported efficiently through pandas.
- Encoders offer robust input to your estimators, and avoid common problems with missing and long tail values. They are well tested to save you from garbage in/garbage out.
- IO connections are configured and pooled in a standard way across the app for popular (no)sql databases, with transaction management and read write optimizations for bulk data, rather than typical ORM single row operations. Connections share a configurable query cache, in addition to encrypted S3 buckets for distributing models and datasets.
- Dependency Management for each individual app in development, that can be 100% replicated to production. No manual activation, or magic env vars, or hidden files that break python for everything else. No knowledge required of venv, pyenv, pyvenv, virtualenv, virtualenvwrapper, pipenv, conda. Ain’t nobody got time for that.
- Tests for your models can be run in your Continuous Integration environment, allowing Continuous Deployment for code and training updates, without increased work for your infrastructure team.
- Workflow Support whether you prefer the command line, a python console, jupyter notebook, or IDE. Every environment gets readable logging and timing statements configured for both production and development.


|model|

Create a Lore project
---------------------

This example demonstrates nested transformers and how to use lore.io with a postgres database `users` table that has feature `first_name` and response `has_subscription` columns. If you don't want to create the database, you can follow a database free example app on medium_.

.. code-block:: bash

  $ pip install lore
  $ lore init my_app --python-version=3.6.4 --keras --xgboost --postgres

  # fix up .env, config/database.cfg, circle.yml, README.rst


A Cute Little Example
---------------------

We'll naively try to predict whether users are subscribers, given their first name. 



Update config/database.cfg to specify your database url:

.. code-block:: ini

  # config/database.cfg

  [MAIN]
  url: $DATABASE_URL

you can set environment variable for only the lore process with the .env file:

.. code-block:: bash

  # .env
  DATABASE_URL=postgres://localhost:5432/development


Create a sql file that specifies your data:

.. code-block:: sql

  -- my_app/extracts/subscribers.sql
  SELECT
    first_name,
    has_subscription
  FROM users
  LIMIT = %(limit)s

Pipelines are the unsexy, but essential component of most machine learning applications. They transform raw data into encoded training (and prediction) data for a model. Lore has several features to make data munging more palatable.

.. code-block:: python

   # my_app/pipelines/subscribers.py
   import lore.io
   import lore.pipelines.holdout
   from lore.encoders import Norm, Discrete, Boolean, Unique
   from lore.transformers import NameAge, NameSex, Log


   class Holdout(lore.pipelines.holdout.Base):

       def get_data(self):
           # lore.io.main is a Connection created by config/database.cfg + DATABASE_URL
           # dataframe() supports keyword args for interpolation (limit)
           # subscribers is the name of the extract
           # cache=True enables LRU query caching
           return lore.io.main.dataframe(filename='subscribers', limit=100, cache=True)

       def get_encoders(self):
           # An arbitrairily chosen set of encoders (w/ transformers)
           # that reference sql columns in the extract by name.
           # A fair bit of thought will probably go into expanding
           # your list with features for your model.
           return (
               Unique('first_name', minimum_occurrences=100),
               Norm(Log(NameAge('first_name'))),
               Discrete(NameSex('first_name'), bins=10),
           )

       def get_output_encoder(self):
           # A single encoder that references the predicted outcome
           return Boolean('has_subscription')


The superclass :python:`lore.pipelines.base.Holdout` will take care of:

- splitting the data into training_data/validation_data/test_data dataframes
- fitting the encoders to training_data
- transforming training_data/validation_data/test_data for the model

Define some models that will fit and predict the data. Base models are designed to be extended and overridden, but work with defaults out of the box.

.. code-block:: python

   # my_app/models/subscribers.py
   import lore.models.keras
   import lore.models.xgboost
   import lore.estimators.keras
   import lore.estimators.xgboost

   from my_app.pipelines.subscribers import Holdout


   class DeepName(lore.models.keras.Base):
       def __init__(self):
           super(DeepName, self).__init__(
               pipeline=Holdout(),
               estimator=lore.estimators.keras.BinaryClassifier() # a canned estimator for deep learning
           )


   class BoostedName(lore.models.xgboost.Base):
       def __init__(self):
           super(BoostedName, self).__init__(
               pipeline=Holdout(),
               estimator=lore.estimators.xgboost.Base() # a canned estimator for XGBoost
           )


Test the models predictive power:

.. code-block:: python

   # tests/unit/test_subscribers.py
   import unittest

   from my_app.models.subscribers import DeepName, BoostedName


   class TestSubscribers(unittest.TestCase):
       def test_deep_name(self):
           model = DeepName()  # initialize a new model
           model.fit(epochs=20)  # fit to the pipeline's training_data
           predictions = model.predict(model.pipeline.test_data)  # predict the holdout
           self.assertEqual(list(predictions), list(model.pipeline.encoded_test_data.y))  # hah!

       def test_xgboosted_name(self):
           model = BoostedName()
           model.fit()
           predictions = model.predict(model.pipeline.test_data)
           self.assertEqual(list(predictions), list(model.pipeline.encoded_test_data.y))  # hah hah hah!

Run tests:

.. code-block:: bash

  $ lore test

Experiment and tune :bash:`notebooks/` with :bash:`$ lore notebook` using the app kernel


Project Structure
-----------------

.. code-block::

  ├── .env.template            <- Template for environment variables for developers (mirrors production)
  ├── README.md                <- The top-level README for developers using this project.
  ├── requirements.txt         <- keeps dev and production in sync (pip)
  ├── runtime.txt              <- keeps dev and production in sync (pyenv)
  │
  ├── data/                    <- query cache and other temp data
  │
  ├── docs/                    <- generated from src
  │
  ├── logs/                    <- log files per environment
  │
  ├── models/                  <- local model store from fittings
  │
  ├── notebooks/               <- explorations of data and models
  │       └── my_exploration/
  │            └── exploration_1.ipynb
  │
  ├── appname/                 <- python module for appname
  │   ├── __init__.py          <- loads the various components (makes this a module)
  │   │
  │   ├── api/                 <- external entry points to runtime models
  │   │   └── my_project.py    <- hub endpoint for predictions
  │   │
  │   ├── extracts/            <- sql
  │   │   └── my_project.sql
  │   │
  │   ├── estimators/          <- Code that make predictions
  │   │   └── my_project.py    <- Keras/XGBoost implementations
  │   │
  │   ├── models/              <- Combine estimator(s) w/ pipeline(s)
  │   │   └── my_project.py
  │   │
  │   └── pipelines/           <- abstractions for processing data
  │       └── my_project.py    <- train/test/split data encoding
  │
  └── tests/
      ├── data/                <- cached queries for fixture data
      ├── models/              <- model store for test runs
      └── unit/                <- unit tests


Modules Overview
================
Lore provides python modules to standardize Machine Learning techniques across multiple libraries.

Core Functionality
------------------
- **lore.models** are compatibility wrappers for your favorite library — `Keras <https://keras.io/>`__, `XGBoost <https://xgboost.readthedocs.io/>`__, `SciKit Learn <http://scikit-learn.org/stable/>`__. They come with reasonable defaults for rough draft training out of the box.
- **lore.pipelines** fetch, encode, and split data into training/test sets for models. A single pipeline will have one Encoder per feature in the model.
- **lore.encoders** operate within Pipelines to transform a single feature into an optimal representation for learning.
- **lore.transformers** provide common operations, like extracting the area code from a free text phone number. They can be chained together inside encoders. They efficiently

Supporting functionality
------------------------
- **lore.io** allows connecting to postgres/redshift and upload/download from s3
- **lore.serializers** persist models with their pipelines and encoders (and get them back again)
- **lore.stores** save intermediate data, for reproducibility and efficiency.

Utilities
---------
- **lore.util** has those extra niceties we rewrite in every project, and then some
- **lore.env** takes care of ensuring that all dependencies are correctly installed before running

Features
========

Integrated Libraries
--------------------
Use your favorite library in a lore project, just like you'd use them in any other python project. They'll play nicely together.

- `Keras <https://keras.io/>`_ (TensorFlow/Theano/CNTK) + `Tensorboard <https://www.tensorflow.org/programmers_guide/summaries_and_tensorboard>`__
- `XGBoost <https://xgboost.readthedocs.io/>`__
- `SciKit-Learn <http://scikit-learn.org/stable/>`__
- `Jupyter Notebook <http://jupyter.org/>`__
- `Pandas <https://pandas.pydata.org/>`__
- `Numpy <http://www.numpy.org/>`__
- `Matplotlib <https://matplotlib.org/>`__, `ggplot <http://ggplot.yhathq.com/>`__, `plotnine <http://plotnine.readthedocs.io/en/stable/>`__
- `SQLAlchemy <https://www.sqlalchemy.org/>`__, `Psycopg2 <http://initd.org/psycopg/docs/>`__
- Hub

Dev Ops
-------
There are `many ways to manage python dependencies in development and production <http://docs.python-guide.org/en/latest/starting/installation/>`_, and each has it's own pitfalls. Lore codifies a solution that “just works” with lore install, which exactly replicates what will be run in production.

**Python compatibility**

- Lore projects will always use the version of python specified in their runtime.txt
- Lore projects use the system service manager (upstart on ubuntu) instead of supervisord which requires python 2.

**Heroku_ buildpack compatibility CircleCI_, Domino_)**

- Lore supports runtime.txt to install and use a consistent version of python in both development and production.
- lore install automatically manages freezing requirements.txt, using a virtualenv, so pip dependencies are exactly the same in development and production. This includes workarounds to support correctly (not) freezing github packages in requirements.txt

**Environment Specific Configuration**

- Lore supports reading environment variables from .env, for easy per project configuration. We recommend .gitignore .env and checking in a .env.template for developer reference to prevent leaking secrets.
- :python:`logging.getLogger(__name__)` is setup appropriately to console, file and/or syslog depending on environment
- syslog is replicated with structured data to loggly_ in production
- lore.util.timer logs info in development, and records  to librato_ in production
- Exception handling logs stack traces in development and test, but reports to rollbar_ in production
- lore console interactive python shell is color coded to prevent environmental confusion

**Multiple concurrent project compatibility**

- Lore manages a distinct python virtualenv for each project, which can be installed from scratch in development with lore install

**Binary library installation for MAXIMUM SPEED**

- Lore can build *tensorflow* from source when it is listed in requirements for development machines, which results in a 2-3x runtime training performance increase. Use lore install --native
- Lore also compiles *xgboost* on OS X with gcc-5 instead of clang to enable automatic parallelization

Lore Library
------------

**IO**

- :python:`lore.io.connection.Connection.select()` and :python:`Connection.dataframe()` can be automatically LRU cached to disk
- :python:`Connection` supports python %(name)s variable replacement in SQL
- :python:`Connection` statements are always annotated with metadata for pgHero
- :python:`Connection` is lazy, for fast startup, and avoids bootup errors in development with low connectivity
- :python:`Connection` supports multiple concurrent database connections

**Serialization**

- Lore serializers provide environment aware S3 distribution for keras/xgboost/scikit models
- Coming soon: heroku buildpack support for serialized models to marry the appropriate code for repeatable and deploys that can be safely rolled back

**Caching**

- Lore provides mulitple configurable cache types, RAM, Disk, coming soon: MemCached & Redis
- Disk cache is tested with pandas to avoid pitfalls encountered serializing w/ csv, h5py, pickle

**Encoders**

- Unique
- Discrete
- Quantile
- Norm

**Transformers**

- AreaCode
- EmailDomain
- NameAge
- NameSex
- NamePopulation
- NameFamilial

**Base Models**

- Abstract base classes for keras, xgboost, and scikit
  - inheriting class to define data(), encoders(), output_encoder(), benchmark()
  - multiple inheritance from custom base class w/ specific ABC for library
- provides hyper parameter optimization

**Fitting**

- Each call to Model.fit() saves the resulting model, along with the params to fit, epoch checkpoints and the resulting statistics, that can be reloaded, or uploaded with a Serializer

**Keras/Tensorflow**

- tensorboard support out of the box with tensorboard --logdir=models
- lore cleans up tensorflow before process exit to prevent spurious exceptions
- lore serializes Keras 2.0 models with extra care, to avoid several bugs (some that only appear at scale)
- ReloadBest callback early stops training on val_loss increase, and reloads the best epoch

**Utils**

- :python:`lore.util.timer` context manager writes to the log in development or librato in production*
- :python:`lore.util.timed` is a decorator for recording function execution wall time

Commands
--------

.. code-block:: bash

  $ lore server  #  start an api process
  $ lore console  # launch a console in your virtual env
  $ lore notebook  # launch jupyter notebook in your virtual env
  $ lore fit MODEL  #  train the model
  $ lore generate [scaffold, model, estimator, pipeline, notebook, test] NAME
  $ lore init [project]  #  create file structure
  $ lore install  #  setup dependencies in virtualenv
  $ lore test  #  make sure the project is in working order
  $ lore pip  #  launch pip in your virtual env
  $ lore python  # launch python in your virtual env


.. |docs| image:: https://readthedocs.org/projects/lore-machine-learning/badge/?version=latest
    :alt: Documentation Status
    :scale: 100%
    :target: http://lore-machine-learning.readthedocs.io/en/latest/?badge=latest
.. |pypi| image:: https://badge.fury.io/py/lore.svg
    :alt: Pip Package Status
    :scale: 100%
    :target: https://pypi.python.org/pypi/lore
.. |circleci| image:: https://circleci.com/gh/instacart/lore.png?style=shield&circle-token=54008e55ae13a0fa354203d13e7874c5efcb19a2
    :alt: Build Status
    :scale: 100%
    :target: https://circleci.com/gh/instacart/lore
.. |mit| image:: https://img.shields.io/badge/License-MIT-blue.svg
    :alt: MIT License
    :scale: 100%
    :target: https://opensource.org/licenses/MIT
.. |model| image:: https://raw.githubusercontent.com/instacart/lore/master/docs/images/model.png
    :alt: Anatomy of a lore model throughout its lifecycle
    :scale: 100%
    :target: http://lore-machine-learning.readthedocs.io/en/latest/
    
.. _Heroku: https://heroku.com/
.. _CircleCI: https://circleci.com/
.. _Domino: https://www.dominodatalab.com/
.. _loggly: https://www.loggly.com/
.. _librato: https://www.librato.com/
.. _rollbar: https://rollbar.com/
.. _medium: https://tech.instacart.com/how-to-build-a-deep-learning-model-in-15-minutes-a3684c6f71e