feature-engine
diff --git a/‎.gitignore
Lines changed: 3 additions & 1 deletion b/‎.gitignore
Lines changed: 3 additions & 1 deletion
diff --git a/‎docs/changelog.rst
Lines changed: 57 additions & 0 deletions b/‎docs/changelog.rst
Lines changed: 57 additions & 0 deletions
diff --git a/‎docs/code_of_conduct.rst
Lines changed: 10 additions & 2 deletions b/‎docs/code_of_conduct.rst
Lines changed: 10 additions & 2 deletions
diff --git a/‎docs/conf.py
Lines changed: 48 additions & 40 deletions b/‎docs/conf.py
Lines changed: 48 additions & 40 deletions
diff --git a/‎docs/contributing/building_the_docs.rst
Lines changed: 10 additions & 7 deletions b/‎docs/contributing/building_the_docs.rst
Lines changed: 10 additions & 7 deletions
@@ -107,6 +107,8 @@ venv.bak/
 
 # Miscelaneous
 .idea
+.vscode
 *.csv
 
-*.DS_Store
+*.DS_Store
+untitled9.py
@@ -3,6 +3,63 @@
 Changelog
 =========
 
+Version 1.0.0
+-------------
+Deployed: TBD
+
+Contributors:
+    - Nodar Okroshiashvili
+    - Nicolas Galli
+    - Tejash Shah
+    - Soledad Galli
+
+
+**Renaming of Modules within Feature-engine**:
+
+Feature-engine transformers have been sorted into submodules to smooth the development
+of the package and shorten import syntax for users.
+
+    - **Module imputation**: missing data imputers are now imported from ``feature_engine.imputation`` instead of ``feature_engine.missing_data_imputation``.
+    - **Module encoding**: categorical variable encoders are now imported from ``feature_engine.encoding`` instead of ``feature_engine_categorical_encoders``.
+    - **Module discretisation**: discretisation transformers are now imported from ``feature_engine.discretisation`` instead of ``feature_engine.discretisers``.
+    - **Module transformation**: transformers are now imported from ``feature_engine.transformation`` instead of ``feature_engine.variable_transformers``.
+    - **Module outliers**: transformers to remove or censor outliers are now imported from ``feature_engine.outliers`` instead of ``feature_engine.outlier_removers``.
+    - **Module selection**: new module hosts transformers to select or remove variables from a dataset.
+    - **Module creation**: new module hosts transformers that combine variables into new features using mathematical or other operations.
+
+**Renaming of Classes**:
+
+In this release, we have shortened the name of categorical encoders, and also renamed
+other classes of Feature-engine to simplify import syntax.
+
+    - **Encoders**: the word ``Categorical`` was removed from the classes name. Now, instead of ``MeanCategoricalEncoder``, the class is called ``MeanEncoder``. Instead of ``RareLabelCategoricalEncoder`` it is ``RareLabelEncoder`` and so on. Please check the encoders documentation for more details.
+    - **Imputers**: the ``CategoricalVariableImputer`` is now called ``CategoricalImputer``.
+    - **Discretisers**: the ``UserInputDiscretiser`` is now called ``ArbitraryDiscretiser``.
+    - **Creation**: the ``MathematicalCombinator`` is not called ``MathematicalCombination``.
+    - **WoEEncoder and PRatioEncoder**: the ``WoEEncoder`` now applies only encoding with the weight of evidence. To apply encoding by probability ratios, use a different transformer: the ``PRatioEncoder`` (**by Nicolas Galli**).
+
+**Renaming of class init Parameters**:
+
+We renamed a few parameters to unify the nomenclature across the Package.
+
+    - **EndTailImputer**: the parameter ``distribution`` is now called ``imputation_method`` to unify convention among imputers. To impute using the IQR, we now need to pass ``imputation_method="iqr"`` instead of ``imputation_method="skewed"``.
+    - **AddMissingIndicator**: the parameter ``missing_only`` now takes the boolean values ``True`` or ``False``.
+    - **Winzoriser and OutlierTrimmer**: the parameter ``distribution`` is now called ``capping_method`` to unify names across Feature-engine transformers.
+
+**New transformers and classes**:
+    - **DropConstantFeatures**: DropConstantFeatures finds and removes constant and quasi-constant features from a dataframe (**by Tejash Shah**)
+    - **DropDuplicateFeatures**: DropDuplicateFeatures finds and removes duplicated features from a dataset (**by Tejash Shah and Soledad Galli**)
+
+**Code Architecture - Important for Contributors and Developers**:
+    - **Submodules**: transformers have been grouped within relevant submodules and modules.
+    - **Individual tests**: testing classes have been subdivided into individual tests
+    - **Code Style**: we adopted the use of flake8 for linting and PEP8 style checks, and black for automatic re-styling of code.
+    - **Type hint**: we are slowly rolling out the use of type hint throughout Feature-engine classes and functions (**by Nodar Okroshiashvili**)
+
+**Other Changes**:
+    - **Updated documentation**: documentation reflects the current use of Feature-engine transformers
+    - **Typo fixes**: Thank you to all who contributed to typo fixes (Tim Vink, Github user @piecot)
+
 Version 0.6.1
 -------------
 Deployed: Friday, September 18, 2020
 
@@ -1,6 +1,14 @@
 Code of Conduct
 ===============
 
-Feature-engine is an open source Python project. We follow the `Python Software Foundation Code of Conduct <http://www.python.org/psf/codeofconduct/>`_. All interactions among members of the Feature-engine community must meet those guidelines. This includes (but is not limited to) interactions through the mailing list, GitHub and StackOverflow.
+Feature-engine is an open source Python project. We follow the
+`Python Software Foundation Code of Conduct <http://www.python.org/psf/codeofconduct/>`_.
+All interactions among members of the Feature-engine community must meet those
+guidelines. This includes (but is not limited to) interactions through the mailing
+list, GitHub and StackOverflow.
 
-Everyone is expected to be open, considerate, and respectful of others no matter what their position is within the project. We show gratitude for any contribution, big or small. We welcome feedback and participation. We want to make Feature-engine a nice, welcoming and safe place for you to do your first contribution to open source, and why not the second, the third and so on :).
+Everyone is expected to be open, considerate, and respectful of others no matter what
+their position is within the project. We show gratitude for any contribution, big or
+small. We welcome feedback and participation. We want to make Feature-engine a nice,
+welcoming and safe place for you to do your first contribution to open source, and why
+not the second, the third and so on :).
@@ -20,9 +20,9 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('../'))
-sys.path.insert(1, os.path.dirname(os.path.abspath('../')) + os.sep + 'feature_engine')
+sys.path.insert(0, os.path.abspath("."))
+sys.path.insert(0, os.path.abspath("../"))
+sys.path.insert(1, os.path.dirname(os.path.abspath("../")) + os.sep + "feature_engine")
 
 # -- General configuration ------------------------------------------------
 
@@ -33,19 +33,20 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
-              #    'sphinx.ext.doctest',
-              'sphinx.ext.intersphinx',
-              'sphinx.ext.todo',
-              'sphinx.ext.coverage',
-              #   'sphinx.ext.mathjax',
-              #   'sphinx.ext.ifconfig',
-              'sphinx.ext.viewcode',
-              'sphinx.ext.githubpages',
-              #    'sphinx.ext.autosummary',
-              'sphinx.ext.napoleon',
-              'numpydoc'
-              ]
+extensions = [
+    "sphinx.ext.autodoc",
+    #    'sphinx.ext.doctest',
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    #   'sphinx.ext.mathjax',
+    #   'sphinx.ext.ifconfig',
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    #    'sphinx.ext.autosummary',
+    "sphinx.ext.napoleon",
+    "numpydoc",
+]
 
 numpydoc_show_class_members = False
 
@@ -54,28 +55,28 @@
 napoleon_use_ivar = False
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'feature-engine'
-copyright = '2018-2020, Soledad Galli'
-author = 'Soledad Galli'
+project = "feature-engine"
+copyright = "2018-2020, Soledad Galli"
+author = "Soledad Galli"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 
-VERSION_PATH = '../feature_engine/VERSION'
-with open(VERSION_PATH, 'r') as version_file:
+VERSION_PATH = "../feature_engine/VERSION"
+with open(VERSION_PATH, "r") as version_file:
     v = version_file.read().strip()
 #
 # The short X.Y version.
@@ -107,7 +108,7 @@
 show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -117,7 +118,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -129,7 +130,7 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = []
-autoclass_content = 'both'
+autoclass_content = "both"
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 html_show_sphinx = True
@@ -140,23 +141,20 @@
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'feature_enginedoc'
+htmlhelp_basename = "feature_enginedoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -166,17 +164,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'feature_engine.tex', 'feature\\_engine Documentation',
-     'Soledad Galli', 'manual'),
+    (
+        master_doc,
+        "feature_engine.tex",
+        "feature\\_engine Documentation",
+        "Soledad Galli",
+        "manual",
+    ),
 ]
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'feature_engine', 'feature_engine Documentation',
-     [author], 1)
+    (master_doc, "feature_engine", "feature_engine Documentation", [author], 1)
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -185,9 +187,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'feature_engine', 'feature_engine Documentation',
-     author, 'feature_engine', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "feature_engine",
+        "feature_engine Documentation",
+        author,
+        "feature_engine",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # -- Options for Epub output ----------------------------------------------
@@ -208,7 +216,7 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}
@@ -3,28 +3,31 @@
 Getting started with Feature-engine documentation
 =================================================
 
-Feature-engine documentation is built using `Sphinx <https://www.sphinx-doc.org>`_ and is hosted on `Read the Docs <https://readthedocs.org/>`_.
+Feature-engine documentation is built using `Sphinx <https://www.sphinx-doc.org>`_ and
+is hosted on `Read the Docs <https://readthedocs.org/>`_.
 
-To learn more about Sphinx follow the `Sphinx Quickstart documentation <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
+To learn more about Sphinx follow the
+`Sphinx Quickstart documentation <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
 
 
 Building the documentation
 --------------------------
 
 First, make sure you have properly installed Sphinx and the required dependencies.
 
-1. If you haven't done so, in your virtual environment, from the root folder of the repository, install the requirements for the documentation::
+1. If you haven't done so, in your virtual environment, from the root folder of the
+repository, install the requirements for the documentation::
 
         $ pip install -r docs/requirements.txt
 
 2. To build the documentation (and test if it is working properly)::
 
     $ sphinx-build -b html docs build
 
-This command tells sphinx that the documentation files are within the docs folder, and the html files should be placed in the
-build folder.
+This command tells sphinx that the documentation files are within the docs folder, and
+the html files should be placed in the build folder.
 
-If everything worked fine, you can navigate the html files located in build. Alternatively, you need to troubleshoot through
-the error messages returned by sphinx.
+If everything worked fine, you can navigate the html files located in build.
+Alternatively, you need to troubleshoot through the error messages returned by sphinx.
 
 Good luck and get in touch if stuck!