Merge pull request #965 from NimaSarajpoor/feature_groups_FS

Fixes 502 Add `feature_groups` parameter to SequentialFeatureSelection

.github/workflows/python-package-conda.yml

@@ -33,9 +33,13 @@ jobs:
         conda install imageio scikit-image -y -q
         conda install dlib -y -q
         pip install markdown
+        pip install coverage
         pip install -e  .
         python -c "import numpy; print('NumPy:', numpy.__version__)"
         python -c "import scipy; print('SciPy:', scipy.__version__)"
         python -c "import sklearn; print('Scikit-learn:', sklearn.__version__)"
         python -c "import pandas; print('Pandas:', pandas.__version__)"
-        pytest -sv
+        coverage run --source=mlxtend --branch -m pytest mlxtend
+        coverage xml
+    - name: Upload Coverage to Codecov
+      uses: codecov/codecov-action@v2

.gitignore

@@ -1,4 +1,5 @@
 # Test Suites
+htmlcov
 .coverage*
 .pytest_cache/
 

.pep8speaks.yml

@@ -7,7 +7,8 @@ scanner:
 flake8:  # Same as scanner.linter value. Other option is flake8
     max-line-length: 88  # Default is 79 in PEP 8
     ignore:  # Errors and warnings to ignore
-        - W504  # line break after binary operator
+        - W504
+        - W503  # line break after binary operator
 
 no_blank_comment: False # If True, no comment is made on PR without any errors.
 descending_issues_order: False  # If True, PEP 8 issues in message will be displayed in descending order of line numbers in the file

README.md

@@ -1,8 +1,8 @@
 [![DOI](https://joss.theoj.org/papers/10.21105/joss.00638/status.svg)](https://doi.org/10.21105/joss.00638)
 [![PyPI version](https://badge.fury.io/py/mlxtend.svg)](http://badge.fury.io/py/mlxtend)
 [![Anaconda-Server Badge](https://anaconda.org/conda-forge/mlxtend/badges/version.svg)](https://anaconda.org/conda-forge/mlxtend)
-[![Build statu  s](https://ci.appveyor.com/api/projects/status/7vx20e0h5dxcyla2/branch/master?svg=true)](https://ci.appveyor.com/project/rasbt/mlxtend/branch/master)
-[![Coverage Status](https://coveralls.io/repos/rasbt/mlxtend/badge.svg?branch=master&service=github)](https://coveralls.io/github/rasbt/mlxtend?branch=master)
+[![Build status](https://ci.appveyor.com/api/projects/status/7vx20e0h5dxcyla2/branch/master?svg=true)](https://ci.appveyor.com/project/rasbt/mlxtend/branch/master)
+[![codecov](https://codecov.io/gh/rasbt/mlxtend/branch/master/graph/badge.svg)](https://codecov.io/gh/rasbt/mlxtend)
 ![Python 3](https://img.shields.io/badge/python-3-blue.svg)
 ![License](https://img.shields.io/badge/license-BSD-blue.svg)
 [![Discuss](https://img.shields.io/badge/discuss-github-blue.svg)](https://github.com/rasbt/mlxtend/discussions)

docs/sources/CHANGELOG.md

@@ -22,7 +22,7 @@ The CHANGELOG for the current development version is available at
 ##### New Features and Enhancements
 
 - The `mlxtend.evaluate.feature_importance_permutation` function has a new `feature_groups` argument to treat user-specified feature groups as single features, which is useful for one-hot encoded features. ([#955](https://github.com/rasbt/mlxtend/pull/955))
-- The `mlxtend.feature_selection.ExhaustiveFeatureSelector` also gained support for `feature_groups` with a behavior similar to the one described above.  ([#957](https://github.com/rasbt/mlxtend/pull/957) via [Nima Sarajpoor](https://github.com/NimaSarajpoor))
+- The `mlxtend.feature_selection.ExhaustiveFeatureSelector` and `SequentialFeatureSelector` also gained support for `feature_groups` with a behavior similar to the one described above.  ([#957](https://github.com/rasbt/mlxtend/pull/957) and [#965](https://github.com/rasbt/mlxtend/pull/965) via [Nima Sarajpoor](https://github.com/NimaSarajpoor))
 
 ##### Changes
 
@@ -33,6 +33,7 @@ The CHANGELOG for the current development version is available at
 - None
 
 
+
 ### Version 0.20.0
 
 #### New Features and Enhancements

docs/sources/CONTRIBUTING.md

@@ -22,9 +22,20 @@ and checking off items as you go.
 5. [ ]  Add appropriate unit test functions in `mlxtend/*/tests`
 6. [ ]  Run `PYTHONPATH='.' pytest ./mlxtend -sv` and make sure that all unit tests pass  
 
-7. [ ]  Modify documentation in the appropriate location under `mlxtend/docs/sources/`  
+7. [ ] Make sure the newly implemented feature has good test coverage:
 
-8. [ ]  Add a note about the modification/contribution to the `./docs/sources/changelog.md` file  
+```
+python -m pip install coverage
+# test all: 
+# coverage run --source=mlxtend --branch -m pytest .
+coverage run --source=mlxtend --branch -m pytest mlxtend/<insert_path>
+coverage html
+```
+
+
+8. [ ]  Modify documentation in the appropriate location under `mlxtend/docs/sources/`  
+
+9. [ ]  Add a note about the modification/contribution to the `./docs/sources/changelog.md` file