CONTRIBUTING.md

Contribution

Changes and improvements are more than welcome! ❤️ Feel free to fork and open a pull request.

Please consider the following :

1. Fork it!
2. Create your feature branch (under dev branch)
3. Add your new features or fix detected bugs
   • To add a new class statistic visit here
   • To add a new overall statistic visit here
   • To add a new interpretation visit here
4. Add standard docstring to your functions/methods according to the standard format
5. Add tests for your functions/methods (doctest, Test folder)
6. Update README.md (if needed)
7. Update Document.ipynb (if needed)
8. Pass all CI tests
9. Update CHANGELOG.md
   • Describe changes under [Unreleased] section
10. Update AUTHORS.md
    • Add your name under # Other Contributors # section
11. Submit a pull request into dev (please complete the pull request template)

Class statistic

1. Add new functions to pycm_class_func.py
2. Update CLASS_PARAMS dictionary in pycm_param.py
3. Update class_statistics function in pycm_class_func.py
   • Call statistic function and store result in result dictionary
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 (IEEE format)
6. Add description to Class Statistics section in Document.ipynb
   • Cite reference
   • Update table of contents
   • 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)

Overall statistic

1. Add new functions to pycm_overall_func.py
2. Update OVERALL_PARAMS dictionary in pycm_param.py
3. Update overall_statistics function in pycm_class_func.py
   • Call statistic function and store result in a variable
   • Add this variable to output
4. Update References section in Document.ipynb (IEEE format)
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)

Interpretation

1. Add new interpretation table as a function to pycm_interpret.py
2. Add a score dictionary to pycm_param.py
   • Example : PLRI_SCORE = {"Good": 4, "Fair": 3, "Poor": 2, "Negligible": 1, "None": "None"}
3. Add a color dictionary to BENCHMARK_COLOR in pycm_param.py
   • Example : "PLRI": {"Negligible": "Red","Poor": "Orange","Fair": "Yellow","Good": "Green","None": "White"}
4. If interpretation table is for a class statistic:
   • Step 2-7 class statistic
   • Update CLASS_BENCHMARK_SCORE_DICT in pycm_param.py
5. If interpretation table is for a overall statistic:
   • Step 2-6 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)

Standard docstring format

Here, the docstring format mainly follows the PEP suggested structure. Note the following items

• Start the docstring description with uppercase letter and end it with a dot
• All other descriptions should be written in lowercase (unless exceptions)
• Declare the abbreviations before using them

Example:

def DF_calc(classes):
    """
    Calculate Chi-squared degree of freedom (DF).

    :param classes: confusion matrix classes
    :type classes: list
    :return: DF as int
    """