ENH initial commit (#1)

.gitignore

@@ -0,0 +1,10 @@
+# Python object files
+*.pyc
+__pycache__
+*egg-info
+
+.DS_Store
+
+# testing
+.coverage
+.cache

.travis.yml

@@ -0,0 +1,16 @@
+notifications:
+    email: false
+language: python
+python:
+    - "2.7"
+    - "3.4"
+    - "3.5"
+    - "3.6"
+install:
+    - pip install --upgrade pip setuptools
+    - pip install -r dev-requirements.txt
+    - pip install -r requirements.txt
+    - pip install -e .
+before_script: flake8 civismlext
+script:
+    - py.test -vv civismlext

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - 2017-09-12
+
+### Added
+
+- initial commit

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to sklearn-extensions
+
+We welcome bug reports and pull requests from everyone!
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## Getting Started
+
+There are two ways to contribute:
+
+### File an Issue
+
+If you find a bug or think of a useful improvement,
+file an issue in this GitHub repository. Make sure to
+include details about what you think should be changed
+and why. If you're reporting a bug, please provide
+a minimum working example so that a maintainer can
+reproduce the bug.
+
+### Modify the Source Code
+
+If you know exactly what needs to change, you can also
+submit a pull request to propose the change.
+
+1. Fork it ( https://github.com/civisanalytics/civisml-extensions/fork ).
+2. Install the dependencies (`pip install -r requirements.txt` and `pip install -r dev-requirements.txt`)
+3. Make sure you are able to run the test suite locally (`pytest`)
+4. Create a feature branch (`git checkout -b my-new-feature`)
+5. Make your change. Don't forget tests
+6. Make sure the test suite, including your new tests, passes (`pytest && flake8`)
+7. Commit your changes (`git commit -am 'Add some feature'`)
+8. Push to the branch (`git push origin my-new-feature`)
+9. Create a new pull request
+10. If the Travis build fails, address any issues
+
+## Tips
+
+- All pull requests must include test coverage. If you’re not sure how to test
+  your changes, feel free to ask for help.
+- Contributions must conform to PEP 8 and the NumPy/SciPy Documentation standards:
+  - [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/)
+  - [A Guide to NumPy/SciPy Documentation](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt)
+- Code in this repo should also conform to the scikit-learn standards. See [their documentation](http://scikit-learn.org/stable/developers/index.html) for more information.
+- Don’t forget to add your change to the [CHANGELOG](CHANGELOG.md). See
+    [Keep a CHANGELOG](http://keepachangelog.com/) for guidelines.
+
+Thank you for taking the time to contribute!

LICENSE.md

@@ -0,0 +1,27 @@
+Copyright (c) 2017, Civis Analytics
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -0,0 +1,4 @@
+include CHANGELOG.md
+include LICENSE.md
+include README.rst
+include requirements.txt

README.rst

@@ -0,0 +1,64 @@
+civisml-extensions
+==================
+
+.. image:: https://www.travis-ci.org/civisanalytics/civisml-extensions.svg?branch=master
+    :target: https://www.travis-ci.org/civisanalytics/civisml-extensions
+
+scikit-learn-compatible estimators from Civis Analytics
+
+Installation
+------------
+
+Installation with ``pip`` is recommended::
+
+    $ pip install civisml-extensions
+
+For development, a few additional dependencies are needed::
+
+    $ pip install -r dev-requirements.txt
+
+Contents and Usage
+------------------
+
+This package contains `scikit-learn`_-compatible estimators for stacking (
+``StackedClassifier``, ``StackedRegressor``), non-negative linear regression (
+``NonNegativeLinearRegression``), preprocessing pandas_ ``DataFrames`` (
+``DataFrameETL``), and using Hyperband_ for cross-validating hyperparameters (
+``HyperbandSearchCV``).
+
+Usage of these estimators follows the standard sklearn conventions. Here is an
+example of using the ``StackedClassifier``::
+
+    >>> from sklearn.linear_model import LogisticRegression
+    >>> from sklearn.ensemble import RandomForestClassifier
+    >>> from civismlext.stacking import StackedClassifier
+    >>> # Note that the final estimator 'metalr' is the meta-estimator
+    >>> estlist = [('rf', RandomForestClassifier()),
+    >>>            ('lr', LogisticRegression()),
+    >>>            ('metalr', LogisticRegression())]
+    >>> mysm = StackedClassifier(estlist)
+    >>> # Set some parameters, if you didn't set them at instantiation
+    >>> mysm.set_params(rf__random_state=7, lr__random_state=8,
+    >>>                 metalr__random_state=9, metalr__C=10**7)
+    >>> # Fit
+    >>> mysm.fit(Xtrain, ytrain)
+    >>> # Predict!
+    >>> ypred = mysm.predict_proba(Xtest)
+
+See the doc strings of the various estimators for more information.
+
+Contributing
+------------
+
+See ``CONTIBUTING.md`` for information about contributing to this project.
+
+License
+-------
+
+BSD-3
+
+See ``LICENSE.md`` for details.
+
+.. _scikit-learn: http://scikit-learn.org/
+.. _pandas: http://pandas.pydata.org/
+.. _Hyperband: https://arxiv.org/abs/1603.06560

civismlext/__init__.py

@@ -0,0 +1,5 @@
+from civismlext.stacking import StackedRegressor  # NOQA
+from civismlext.stacking import StackedClassifier  # NOQA
+from civismlext.nonnegative import NonNegativeLinearRegression  # NOQA
+from civismlext.hyperband import HyperbandSearchCV  # NOQA
+from civismlext.preprocessing import DataFrameETL  # NOQA

civismlext/_version.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'