EducationalTestingService / skll

SciKit-Learn Laboratory (SKLL) makes it easy to run machine learning experiments.
http://skll.readthedocs.org
Other
550 stars 69 forks source link

Improve docstrings & type hints (Part 4) #740

Closed desilinguist closed 1 year ago

desilinguist commented 1 year ago

To review this, please look at the built documentation and check that under "API documentation", look at the sections "metrics Package" and "utils Package" and confirm that:

This is the final PR for #647. Closes #647.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (6409e06) 95.19% compared to head (89b4543) 95.19%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #740 +/- ## ======================================= Coverage 95.19% 95.19% ======================================= Files 29 29 Lines 3535 3535 ======================================= Hits 3365 3365 Misses 170 170 ``` | [Impacted Files](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService) | Coverage Δ | | |---|---|---| | [skll/learner/\_\_init\_\_.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9sZWFybmVyL19faW5pdF9fLnB5) | `97.18% <ø> (ø)` | | | [skll/metrics.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9tZXRyaWNzLnB5) | `97.08% <ø> (ø)` | | | [...utils/commandline/compute\_eval\_from\_predictions.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC91dGlscy9jb21tYW5kbGluZS9jb21wdXRlX2V2YWxfZnJvbV9wcmVkaWN0aW9ucy5weQ==) | `97.50% <ø> (ø)` | | | [skll/utils/commandline/filter\_features.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC91dGlscy9jb21tYW5kbGluZS9maWx0ZXJfZmVhdHVyZXMucHk=) | `98.50% <ø> (ø)` | | | [skll/utils/commandline/generate\_predictions.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC91dGlscy9jb21tYW5kbGluZS9nZW5lcmF0ZV9wcmVkaWN0aW9ucy5weQ==) | `98.68% <ø> (ø)` | | | [skll/utils/commandline/join\_features.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC91dGlscy9jb21tYW5kbGluZS9qb2luX2ZlYXR1cmVzLnB5) | `98.18% <ø> (ø)` | | | [skll/utils/commandline/plot\_learning\_curves.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC91dGlscy9jb21tYW5kbGluZS9wbG90X2xlYXJuaW5nX2N1cnZlcy5weQ==) | `96.42% <ø> (ø)` | | | [skll/utils/commandline/print\_model\_weights.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC91dGlscy9jb21tYW5kbGluZS9wcmludF9tb2RlbF93ZWlnaHRzLnB5) | `95.00% <ø> (ø)` | | | [skll/utils/commandline/run\_experiment.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC91dGlscy9jb21tYW5kbGluZS9ydW5fZXhwZXJpbWVudC5weQ==) | `96.87% <ø> (ø)` | | | [skll/utils/commandline/skll\_convert.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC91dGlscy9jb21tYW5kbGluZS9za2xsX2NvbnZlcnQucHk=) | `93.15% <ø> (ø)` | | | ... and [2 more](https://app.codecov.io/gh/EducationalTestingService/skll/pull/740?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService) | |

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