Add type hints in`skll.utils` module and in all other remaining files. #736

desilinguist · 2023-05-31T23:21:01Z

Add type hints to skll.utils package.
Add type hints to metrics.py and logging.py.
Add type hints to skll.data.* that were missed in previous PRs.
Refactor some code as necessary.
Update all docstrings.
Ignore some type errors that are redundant.

This is the last series of type-hinting PRs and will close #561.

codecov · 2023-05-31T23:40:56Z

Codecov Report

Patch coverage: 98.71% and no project coverage change.

Comparison is base (9ab864e) 95.20% compared to head (b5e7f86) 95.21%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #736   +/-   ##
=======================================
  Coverage   95.20%   95.21%           
=======================================
  Files          29       29           
  Lines        3504     3531   +27     
=======================================
+ Hits         3336     3362   +26     
- Misses        168      169    +1

Impacted Files	Coverage Δ
skll/data/featureset.py	`91.57% <ø> (ø)`
skll/metrics.py	`97.08% <96.15%> (-0.83%)`	⬇️
skll/data/readers.py	`90.42% <100.00%> (+0.06%)`	⬆️
skll/data/writers.py	`93.65% <100.00%> (ø)`
...utils/commandline/compute_eval_from_predictions.py	`97.50% <100.00%> (+0.31%)`	⬆️
skll/utils/commandline/filter_features.py	`98.50% <100.00%> (+0.02%)`	⬆️
skll/utils/commandline/generate_predictions.py	`98.68% <100.00%> (+0.01%)`	⬆️
skll/utils/commandline/join_features.py	`98.18% <100.00%> (+0.03%)`	⬆️
skll/utils/commandline/plot_learning_curves.py	`96.42% <100.00%> (+0.13%)`	⬆️
skll/utils/commandline/print_model_weights.py	`95.00% <100.00%> (+0.08%)`	⬆️
... and 4 more

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

mulhod

Minor comments. Looks great!

skll/utils/commandline/compute_eval_from_predictions.py

I forgot to add type hints in some places in `skll.data*` in previous PRs. This commit adds them.

skll/data/readers.py

skll/utils/commandline/filter_features.py

desilinguist added 2 commits May 31, 2023 18:31

chore: update skll.utils with type hints.

840023e

chore: type hints for metrics and logging

c34a7b8

desilinguist requested review from Frost45, damien2012eng, dblandan, mulhod and tamarl08 May 31, 2023 23:21

desilinguist self-assigned this May 31, 2023

mulhod approved these changes Jun 1, 2023

View reviewed changes

skll/utils/commandline/compute_eval_from_predictions.py Outdated Show resolved Hide resolved

skll/utils/commandline/compute_eval_from_predictions.py Outdated Show resolved Hide resolved

desilinguist added 3 commits June 1, 2023 10:38

fix: address PR comments.

bd325dd

docs: fix sklearn.metrics.kappa docstring.

15ce04b

fix: add missing type hints

b5e7f86

I forgot to add type hints in some places in `skll.data*` in previous PRs. This commit adds them.