Add Type Hints (Final Part) #683

desilinguist · 2024-02-12T23:25:28Z

Changes

Add intersphinx mapping for prompt_toolkit
Add type hints for utils.commandline
Add type hints for utils.conversion
Add type hints for utils.cross_validation
Add type hints for utils.files
Add type hints for utils.logging
Add type hints for utils.metrics
Add type hints for utils.models
Add type hints for utils.notebook
Add type hints for utils.prmse.
Add type hints for utils.wandb

How to review

Please check that I have not left any parameters/arguments/return values without type hints.
Please check that the types in the docstrings match those in the actual code.
Here's the RTD build for this branch. Check the "API Documentation" section (for the files affected by this MR) to confirm that all types are linked to relevant pages from external documentations (e.g., Python, Numpy, SKLL, stats models etc.) and there are no typos etc.
Check for typos and/or weird issues in docstrings.

codecov · 2024-02-12T23:48:47Z

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (32b91b7) 96.10% compared to head (0239498) 96.10%.

Files	Patch %	Lines
rsmtool/utils/cross_validation.py	85.71%	1 Missing ⚠️
rsmtool/utils/prmse.py	88.88%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #683   +/-   ##
=======================================
  Coverage   96.10%   96.10%           
=======================================
  Files          32       32           
  Lines        4517     4546   +29     
=======================================
+ Hits         4341     4369   +28     
- Misses        176      177    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

rsmtool/utils/files.py

rsmtool/utils/logging.py

rsmtool/utils/metrics.py

rsmtool/utils/conversion.py

rsmtool/utils/notebook.py

rsmtool/utils/wandb.py

rsmtool/utils/conversion.py

rsmtool/utils/commandline.py

tamarl08 · 2024-02-14T18:05:16Z

@desilinguist done! :)

desilinguist · 2024-02-14T18:05:59Z

Thank you so much for the careful review, @tamarl08! 🙇🏽

desilinguist added 12 commits February 9, 2024 15:05

docs: add intersphinx mapping for prompt_toolkit

0dcad58

chore: add type hints for utils.commandline

3bc3548

chore: add type hints for utils.conversion

3f0b0e1

chore: add type hints for utils.cross_validation

2525f39

chore: add type hints for utils.files

5899b7e

chore: add type hints for utils.logging

1d2073e

chore: add type hints for utils.metrics

8a25e4f

chore: add type hints for utils.models

9233689

chore: add type hints for utils.notebook

fca4695

chore: add type hints for utils.prmse.

646c366

chore: add type hints for utils.wandb

e3d9208

fix: stray typos and incorrect docstrings

822da5f

desilinguist requested review from Frost45, damien2012eng, mulhod and tamarl08 February 12, 2024 23:25

fix: make check more specific and update docstring

867c210

damien2012eng reviewed Feb 13, 2024

View reviewed changes

rsmtool/utils/files.py Outdated Show resolved Hide resolved

damien2012eng reviewed Feb 13, 2024

View reviewed changes

rsmtool/utils/logging.py Outdated Show resolved Hide resolved

damien2012eng reviewed Feb 13, 2024

View reviewed changes

rsmtool/utils/metrics.py Show resolved Hide resolved

damien2012eng approved these changes Feb 13, 2024

View reviewed changes

mulhod approved these changes Feb 14, 2024

View reviewed changes