change docs layout to pydata sphinx theme (#314)

* replaces readthedocs by pydata doc template

* reorganizes files to tidy navigation tab

* adds packt attribution link

* edits startpage and quickstart

* major rearrangement of files to make docs work

* fixes wording, reorganizes more files

* update arbitrary number imputer

* update mean median imputer

* update end tail imputer

* update categorical imputer

* update random sample imputer

* update missing indicator

* update drop na imputer

* adds class link to user guide imputation

* update user guide and api creation

* updates index of creation modules

* updates arbitrary and tree discretizers

* update equal frequency disc

* updates equal width discretiser

* update count encoding

* update tree encoder

* update one hot encoder

* update ordinal encoder

* updates remaining encoders

* revises intro and updates tab names

* reviews and updates quickstart files

* reviews and updates imputation api docs

* add table undertitle

* adds '' to string param values

* reviews and updates encoding api docs

* adds markdown tables

* reviews and updates discretisation api

* review and update creation api

* reorganises selection files into user guide and api

* reorganises files into api and user guide for outliers

* reorganises files into user guide and api for transformation

* rewords return in inverse_transform method

* reorganises preprocessing into user gudie and api

* reorganises files into user guide and api for wrapper

* updates and reorganises the learning resources

* updates and improves about

* reviews and edits transformation and outlier api docs

* review and update wrappers and preprocessors api files

* reviews and edits selection api files

* final update about and learning resources

* updates user guide wrappers

* final edits preprocessors user guide

* reviews and edits imputation user guide

* reviews and edits user guide encoding

* final edit to encoding user guide index

* edits main transformations in user guide

* edits final transformation user guide files

* final edits to discretisation user guide files

* final review user guide outliers and creation

* changes capitalization of figure name

* review some of selection user guide files

* edits user guide correlation transformers

* updates more selection user guide files

* final edits to user guide selection

* reorganises contribute files

* update contribute index

* updates contribute code guidelines

* edits contribute code file

* final update contribute section

* reorganises whats new

* adds smoothing info to target encoder user guide

* re-inserts paths to doc config file

* add functionality to drop data based on percentage of NA in DropMissingData (#322)

* DropMissingData thresh_pct param

* adding thresh_pct & test_thresh_pct to DropMissingData

* renamed test to correct thresh

* add fit_transform to test_thresh_pct & pass tox

* update doc naming

* rename thresh_pct to drop_pct for clarity, added tests, rebase from pydata_template

* Refactoring to row_drop_pct, still under discussion.

* pass black, isort, & flake8

* tox.ini had incorrect indentation, resolving

* remove non-relevant files from PR

* update init docstrings

* adds final edits to logic plus todo list

* threshold tests with new logic & return_na_data

* changes wording in test comments

@kevinkurek I forgot that I could edit files directly from the PR

* updating comments, at least 1% must be available

* re word docstrings for param threshold

@kevinkurek could you double check that this wording is correct?

Co-authored-by: Soledad Galli <[email protected]>

* update readme

* add logo to readme

* final update readme

Co-authored-by: Kevin <[email protected]>

Author: solegalli

README.md

@@ -1,55 +1,58 @@
 # Feature Engine
 
 ![PythonVersion](https://img.shields.io/badge/python-3.6%20|3.7%20|%203.8%20|%203.9-success)
-[![PyPI version](https://badge.fury.io/py/feature-engine.svg)](https://badge.fury.io/py/feature-engine)
 [![License https://github.com/feature-engine/feature_engine/blob/master/LICENSE.md](https://img.shields.io/badge/license-BSD-success.svg)](https://github.com/feature-engine/feature_engine/blob/master/LICENSE.md)
+[![PyPI version](https://badge.fury.io/py/feature-engine.svg)](https://badge.fury.io/py/feature-engine)
+[![Conda https://anaconda.org/conda-forge/feature_engine](https://anaconda.org/conda-forge/feature_engine/badges/installer/conda.svg)](https://anaconda.org/conda-forge/feature_engine)
 [![CircleCI https://app.circleci.com/pipelines/github/feature-engine/feature_engine?branch=1.1.X](https://img.shields.io/circleci/build/github/feature-engine/feature_engine)](https://app.circleci.com/pipelines/github/feature-engine/feature_engine?branch=1.1.X)
 [![Documentation Status https://feature-engine.readthedocs.io/en/latest/index.html](https://readthedocs.org/projects/feature-engine/badge/?version=latest)](https://feature-engine.readthedocs.io/en/latest/index.html)
 [![Join the chat at https://gitter.im/feature_engine/community](https://badges.gitter.im/feature_engine/community.svg)](https://gitter.im/feature_engine/community)
 [![Sponsorship https://www.trainindata.com/](https://img.shields.io/badge/Powered%20By-TrainInData-orange.svg)](https://www.trainindata.com/)
 [![Downloads](https://pepy.tech/badge/feature-engine)](https://pepy.tech/project/feature-engine)
 [![Downloads](https://pepy.tech/badge/feature-engine/month)](https://pepy.tech/project/feature-engine)
-[![Conda https://anaconda.org/conda-forge/feature_engine](https://anaconda.org/conda-forge/feature_engine/badges/installer/conda.svg)](https://anaconda.org/conda-forge/feature_engine)
 [![DOI](https://zenodo.org/badge/163630824.svg)](https://zenodo.org/badge/latestdoi/163630824)
 [![DOI](https://joss.theoj.org/papers/10.21105/joss.03642/status.svg)](https://doi.org/10.21105/joss.03642)
 
 
+[<img src="./docs/images/logo/FeatureEngine.png" width="248">](http://feature-engine.readthedocs.io)
+
 Feature-engine is a Python library with multiple transformers to engineer and select features for use in machine learning models. 
-Feature-engine's transformers follow scikit-learn's functionality with fit() and transform() methods to first learn the 
-transforming parameters from data and then transform the data.
+Feature-engine's transformers follow Scikit-learn's functionality with fit() and transform() methods to learn the 
+transforming parameters from the data and then transform it.
 
 
-## Feature-engine features in the following resources:
+## Feature-engine features in the following resources
 
 * [Feature Engineering for Machine Learning, Online Course](https://www.udemy.com/course/feature-engineering-for-machine-learning/?referralCode=A855148E05283015CF06)
 
 * [Feature Selection for Machine Learning, Online Course](https://www.udemy.com/course/feature-selection-for-machine-learning/?referralCode=186501DF5D93F48C4F71)
 
-* [Python Feature Engineering Cookbook](https://www.packtpub.com/data/python-feature-engineering-cookbook)
-
 * [Deployment of Machine Learning Models, Online Course](https://www.udemy.com/course/deployment-of-machine-learning-models/?referralCode=D4FE5EA129FFD203CFF4)
 
-## Blogs about Feature-engine:
+* [Python Feature Engineering Cookbook](https://packt.link/python)
+
+
+## Blogs about Feature-engine
 
 * [Feature-engine: A new open-source Python package for feature engineering](https://trainindata.medium.com/feature-engine-a-new-open-source-python-package-for-feature-engineering-29a0ab88ea7c)
 
 * [Practical Code Implementations of Feature Engineering for Machine Learning with Python](https://towardsdatascience.com/practical-code-implementations-of-feature-engineering-for-machine-learning-with-python-f13b953d4bcd)
 
-## Documentation
-
-* [Documentation](http://feature-engine.readthedocs.io)
-* [Home page](https://www.trainindata.com/feature-engine)
 
-## En Español:
+## En Español
 
 * [Ingeniería de variables para machine learning, Curso Online](https://www.udemy.com/course/ingenieria-de-variables-para-machine-learning/?referralCode=CE398C784F17BD87482C)
 
 * [Ingeniería de variables, MachinLenin, charla online](https://www.youtube.com/watch?v=NhCxOOoFXds)
 
-More resources will be added as they appear online!
+
+## Documentation
+
+* [Documentation](http://feature-engine.readthedocs.io)
 
 
 ## Current Feature-engine's transformers include functionality for:
+
 * Missing Data Imputation
 * Categorical Variable Encoding
 * Outlier Capping or Removal
@@ -60,7 +63,7 @@ More resources will be added as they appear online!
 * Scikit-learn Wrappers
 * Preprocessing
 
-### Imputing Methods
+### Imputation Methods
 * MeanMedianImputer
 * RandomSampleImputer
 * EndTailImputer
@@ -98,9 +101,6 @@ More resources will be added as they appear online!
 * BoxCoxTransformer
 * YeoJohnsonTransformer
 
-### Scikit-learn Wrapper:
- * SklearnTransformerWrapper
-
 ### Variable Creation:
  * MathematicalCombination
  * CombineWithReferenceFeature
@@ -120,8 +120,11 @@ More resources will be added as they appear online!
 
 ### Preprocessing
  * MatchVariables
+ 
+### Wrappers:
+ * SklearnTransformerWrapper
 
-## Installing
+## Installation
 
 From PyPI using pip:
 
@@ -133,15 +136,15 @@ From Anaconda:
 
 ```
 conda install -c conda-forge feature_engine
-
 ```
+
 Or simply clone it:
 
 ```
 git clone https://github.com/feature-engine/feature_engine.git
 ```
 
-### Usage
+## Example Usage
 
 ```python
 >>> import pandas as pd
@@ -175,58 +178,38 @@ Rare     3
 Name: var_A, dtype: int64
 ```
 
-See more usage examples in the Jupyter Notebooks in the **example** folder of this repository, or in the [documentation](http://feature-engine.readthedocs.io).
+Find more examples in our [Jupyter Notebook Gallery](https://nbviewer.org/github/feature-engine/feature-engine-examples/tree/main/) 
+or in the [documentation](http://feature-engine.readthedocs.io).
 
-## Contributing
+## Contribute
 
-Details about how to contribute can be found in the [Contributing Page](https://feature-engine.readthedocs.io/en/latest/contribute/index.html)
+Details about how to contribute can be found in the [Contribute Page](https://feature-engine.readthedocs.io/en/latest/contribute/index.html)
 
-In short:
+Briefly:
 
-### Local Setup Steps
 - Fork the repo
 - Clone your fork into your local computer: ``git clone https://github.com/<YOURUSERNAME>/feature_engine.git``
-- cd into the repo ``cd feature_engine``
-- Install as a developer: ``pip install -e .``
-- Create and activate a virtual environment with any tool of choice
-- Install the dependencies as explained in the [Contributing Page](https://feature-engine.readthedocs.io/en/latest/contribute/index.html)
+- navigate into the repo folder ``cd feature_engine``
+- Install Feature-engine as a developer: ``pip install -e .``
+- Optional: Create and activate a virtual environment with any tool of choice
+- Install Feature-engine dependencies: ``pip install -r requirements.txt`` and ``pip install -r test_requirements.txt``
 - Create a feature branch with a meaningful name for your feature: ``git checkout -b myfeaturebranch``
 - Develop your feature, tests and documentation
 - Make sure the tests pass
 - Make a PR
 
 Thank you!!
 
-### Opening Pull Requests
-PR's are welcome! Please make sure the CI tests pass on your branch.
-
-### Tests
-
-We prefer tox. In your environment:
-
-- Run `pip install tox`
-- cd into the root directory of the repo: ``cd feature_engine``
-- Run `tox` 
-
-If the tests pass, the code is functional.
-
-You can also run the tests in your environment (without tox). For guidelines on how to do so, check the [Contributing Page](https://feature-engine.readthedocs.io/en/latest/contribute/index.html).
-
 
 ### Documentation
 
 Feature-engine documentation is built using [Sphinx](https://www.sphinx-doc.org) and is hosted on [Read the Docs](https://readthedocs.org/).
 
-To build the documentation make sure you have the dependencies installed. From the root directory: ``pip install -r docs/requirements.txt``.
+To build the documentation make sure you have the dependencies installed: from the root directory: ``pip install -r docs/requirements.txt``.
 
-Now you can build the docs: ``sphinx-build -b html docs build``
+Now you can build the docs using: ``sphinx-build -b html docs build``
 
 
 ## License
 
 BSD 3-Clause
-
-
-## References
-
-Many of the engineering and encoding functionalities are inspired by this [series of articles from the 2009 KDD Competition](http://www.mtome.com/Publications/CiML/CiML-v3-book.pdf).

docs/_static/css/feature-engine.css

@@ -1,20 +1,39 @@
 @import url("theme.css");
 
-.highlight a {
-    text-decoration: underline;
+
+/* Css template from sklearn:
+https://github.com/scikit-learn/scikit-learn/blob/f71c0313142c4e5f2f35a0021c36075cf8dba611/doc/themes/scikit-learn-modern/static/css/theme.css
+*/
+
+/* authors */
+.authors-container {
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: center;
 }
 
-.wy-nav-content {
-    max-width: 1200px !important;
+
+/* sponsors and testimonials */
+
+div.sk-sponsor-div, div.sk-testimonial-div {
+  display: flex;
+  flex-wrap: wrap;
+  -webkit-flex-align: center;
+  -ms-flex-align: center;
+  -webkit-align-items: center;
+  align-items: center;
 }
 
+div.sk-sponsor-div-box, div.sk-testimonial-div-box {
+  width: 100%;
+}
 
-.wy-table-responsive {
-    overflow: visible !important;
+@media screen and (min-width: 500px) {
+  div.sk-sponsor-div-box, div.sk-testimonial-div-box {
+    width: 50%;
+  }
 }
 
-.classifier:before {
-    font-style: normal;
-    margin: 0.5em;
-    content: ":";
+.caption {
+  text-align: center
 }

docs/_templates/breadcrumbs.html

@@ -0,0 +1,26 @@
+{{objname}}
+{{ underline }}==============
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+
+   {% if methods %}
+   .. rubric:: Methods
+
+   .. autosummary::
+   {% for item in methods %}
+      {% if '__init__' not in item %}
+        ~{{ name }}.{{ item }}
+      {% endif %}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+.. include:: {{module}}.{{objname}}.examples
+
+.. raw:: html
+
+    <div style='clear:both'></div>

docs/_templates/class.rst

@@ -22,7 +22,7 @@ Governance
 ----------
 
 The decision making process and governance structure of Feature-engine is laid out in
-the `governance document <https://feature-engine.readthedocs.io/en/latest/governance.html>`_.
+the :ref:`**governance document** <governance>`.
 
 Core contributors
 -----------------
@@ -35,6 +35,7 @@ and maintenance:
 Contributors
 ------------
 
+A growing international community is beginning to lead Feature-engine's development.
 You can learn more about Feature-engine's Contributors in the
 `GitHub contributors page <https://github.com/feature-engine/feature_engine/graphs/contributors>`_.
 
@@ -47,6 +48,8 @@ Citing Feature-engine
 .. image:: https://joss.theoj.org/papers/10.21105/joss.03642/status.svg
    :target: https://joss.theoj.org/papers/10.21105/joss.03642
 
+|
+
 If you use Feature-engine in a scientific publication, you can cite the following paper:
 Galli, S., (2021). `Feature-engine: A Python package for feature engineering for machine learning. <https://joss.theoj.org/papers/10.21105/joss.03642>`_
 Journal of Open Source Software, 6(65), 3642.
@@ -81,19 +84,54 @@ Artwork
 High quality PNG and SVG logos are available in the `docs/images/ <https://github.com/feature-engine/feature_engine/tree/main/docs/images/logo>`_
 source directory of the repository.
 
-.. figure::  images/logo/FeatureEngine.png
-   :align:   center
+.. figure::  ../images/logo/FeatureEngine.png
+   :width: 200
+   :figclass: align-center
+   :align: center
 
 
 Sponsors
 --------
 
 Feature-engine is a community driven project, however institutional and private grants
-help to assure its sustainability.
+help to assure its sustainability. The project would like to thank the following
+sponsors:
+
+|
+|
+
+.. raw:: html
+
+   </div>
+   </div>
+
+........
+
+.. raw:: html
+
+   <div class="sk-sponsor-div">
+   <div class="sk-sponsor-div-box">
+
+Soledad Galli spends a big part of her time at `Train in Data <https://www.trainindata.com/>`_
+maintaining the project.
+
+.. raw:: html
+
+   </div>
+
+   <div class="sk-sponsor-div-box">
+
+.. image:: ../images/sponsors/trainindata.png
+   :width: 150pt
+   :align: center
+   :target:  https://www.trainindata.com/
+
+.. raw:: html
 
-The project would like to thank the following sponsors:
+   </div>
+   </div>
 
-Soledad Galli spends a big part of her time at Train in Data maintaining the project.
+..........
 
-.. image:: images/sponsors/trainindata.png
-   :target: https://www.trainindata.com/
+|
+|

docs/about.rst renamed to docs/about/about.rst

@@ -0,0 +1,21 @@
+.. raw :: html
+
+    <!-- Generated by generate_authors_table.py -->
+    <div class="authors-container">
+        <style>
+          img.avatar {border-radius: 15px; padding: 10px;}
+          .author {text-align: center;}
+        </style>
+        <div class="author">
+            <a href='https://github.com/solegalli'><img src='https://avatars.githubusercontent.com/solegalli?v=4' class='avatar' width="120" height="120" /></a> <br />
+            <p>Soledad Galli</p>
+        </div>
+        <div class="author">
+            <a href='https://github.com/christophergs'><img src='https://avatars.githubusercontent.com/christophergs?v=4' width="120" height="120"class='avatar' /></a> <br />
+            <p>Chris Samiullah</p>
+        </div>
+        <div class="author">
+            <a href='https://github.com/nicogalli'><img src='https://avatars.githubusercontent.com/nicogalli?v=4' class='avatar'width="120" height="120"/></a> <br />
+            <p>Nicolas Galli</p>
+        </div>
+    </div>