Merge pull request #287 from sepandhaghighi/dev

Version 2.6

.gitattributes

@@ -1 +1,2 @@
 Document/* linguist-vendored
+Otherfiles/test.html linguist-vendored

.github/CONTRIBUTING.md

@@ -31,7 +31,7 @@ Please consider the following :
 	- Define a new variable as a dictionary
 	- Call statistic function and store result in this variable
 	- Add this variable to `result` dictionary
-3. Update `__class_stat_init__` function in `pycm_obj.py` by a new attribute
+3. Update `__class_stat_init__` function in `pycm_handler.py` by a new attribute
 4. Update `PARAMS_DESCRIPTION` dictionary in `pycm_param.py` by a short description
 	- If you don't want capitalization, update `CAPITALIZE_FILTER` list in `pycm_param.py` (*Optional*)
 5. Update `References` section in `Document.ipynb` and `README.md`
@@ -41,6 +41,7 @@ Please consider the following :
 	- Use `LaTeX` for formula
 7. Update `PARAMS_LINK` dictionary in `pycm_param.py` by document tag (without `#`)
 8. Add tests to `overall_test.py` and `function_test.py` in `TEST` folder
+	- If you have any verified test add them to `verified_test.py`
 9. Run `autopep8.bat`/`autopep8.sh` (*Optional*, need to install latest version of `autopep8` package)
 
 
@@ -51,14 +52,15 @@ Please consider the following :
 2. Update `overall_statistics` function in `pycm_class_func.py`
 	- Call statistic function and store result in a variable
 	- Add this variable to output
-3. Update `__overall_stat_init__` function in `pycm_obj.py` by a new attribute
+3. Update `__overall_stat_init__` function in `pycm_handler.py` by a new attribute
 4. Update `References` section in `Document.ipynb` and `README.md`
 5. Add description to `Overall Statistics` section in `Document.ipynb`
 	- Cite reference
 	- Update table of contents
 	- Use `LaTeX` for formula
 6. Update `PARAMS_LINK` dictionary in `pycm_param.py` by document tag (without `#`)
 7. Add tests to `overall_test.py` and `function_test.py` in `TEST` folder
+	- If you have any verified test add them to `verified_test.py`
 8. Run `autopep8.bat`/`autopep8.sh` (*Optional*, need to install latest version of `autopep8` package)
 
 
@@ -77,4 +79,5 @@ Please consider the following :
 	- Step 2-6 [overall statistic](#overall-statistic)
 	- Update `OVERALL_BENCHMARK_SCORE_DICT` in `pycm_param.py`
 6. Add tests to `compare_test.py`, `overall_test.py` and `function_test.py` in `TEST` folder
+	- If you have any verified test add them to `verified_test.py`
 7. Run `autopep8.bat`/`autopep8.sh` (*Optional*, need to install latest version of `autopep8` package)

.travis.yml

@@ -2,6 +2,9 @@ language: python
 
 matrix:
     include:
+        - os: linux
+          python: 3.8
+          dist: xenial
         - os: linux
           python: 3.7
           dist: xenial

.travis/test.sh

@@ -19,7 +19,7 @@
 
   if [ "$IS_IN_TRAVIS" = 'false' ] || [ "$TRAVIS_PYTHON_VERSION" = '3.6' ]
   then
-      $PYTHON_COMMAND -m vulture pycm/ Otherfiles/ setup.py --min-confidence 65 --exclude=build,.eggs --sort-by-size
+      $PYTHON_COMMAND -m vulture pycm/ Otherfiles/ setup.py --min-confidence 65 --exclude=__init__.py --sort-by-size
       $PYTHON_COMMAND -m bandit -r pycm -s B311
       $PYTHON_COMMAND -m pydocstyle --match-dir=pycm
   fi

AUTHORS.md

@@ -13,3 +13,4 @@
 - [Mohammad Mahdi Rahimi](https://github.com/mahi97)
 - [Sadra Sabouri](https://github.com/sadrasabouri)
 - [Christian Clauss](https://github.com/cclauss)
+- [Negar Zabetian](https://github.com/negarzabetian)

CHANGELOG.md

@@ -5,6 +5,38 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [2.6] - 2020-03-25
+### Added
+- `custom_rounder` function
+- `complement` function
+- `sparse_matrix` attribute
+- `sparse_normalized_matrix` attribute 
+- Net benefit (NB)
+- Yule's Q interpretation (QI)
+- Adjusted Rand index (ARI)
+- TNR micro/macro
+- FPR micro/macro
+- FNR micro/macro
+### Changed
+- `sparse` parameter added to `print_matrix`,`print_normalized_matrix` and `save_stat` methods
+- `header` parameter added to `save_csv` method
+- Handler functions moved to `pycm_handler.py`
+- Error objects moved to `pycm_error.py`
+- Verified tests references updated
+- Verified tests moved to `verified_test.py`
+- Test system modified 
+- `CONTRIBUTING.md` updated
+- Namespace optimized
+- `README.md` modified
+- Document modified
+- `print_normalized_matrix` method modified
+- `normalized_table_calc` function modified
+- `setup.py` modified
+- summary mode updated
+- Dockerfile updated
+- `Python 3.8` added to `.travis.yaml` and `appveyor.yml`
+### Removed
+- `PC_PI_calc` function
 ## [2.5] - 2019-10-16
 ### Added
 - `__version__` variable
@@ -436,7 +468,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - TPR
 - documents and `README.md`
 
-[Unreleased]: https://github.com/sepandhaghighi/pycm/compare/v2.5...dev
+[Unreleased]: https://github.com/sepandhaghighi/pycm/compare/v2.6...dev
+[2.6]: https://github.com/sepandhaghighi/pycm/compare/v2.5...v2.6
 [2.5]: https://github.com/sepandhaghighi/pycm/compare/v2.4...v2.5
 [2.4]: https://github.com/sepandhaghighi/pycm/compare/v2.3...v2.4
 [2.3]: https://github.com/sepandhaghighi/pycm/compare/v2.2...v2.3