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 and type hints (Part 3) #739

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 "experiments Package" and "learner Package" and confirm that:

This is part of #647.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (b8be359) 95.18% compared to head (6737a7b) 95.19%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #739 +/- ## ======================================= Coverage 95.18% 95.19% ======================================= Files 29 29 Lines 3533 3535 +2 ======================================= + Hits 3363 3365 +2 Misses 170 170 ``` | [Impacted Files](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService) | Coverage Δ | | |---|---|---| | [skll/data/readers.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9kYXRhL3JlYWRlcnMucHk=) | `90.42% <ø> (ø)` | | | [skll/data/writers.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9kYXRhL3dyaXRlcnMucHk=) | `93.20% <ø> (ø)` | | | [skll/experiments/input.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9leHBlcmltZW50cy9pbnB1dC5weQ==) | `100.00% <ø> (ø)` | | | [skll/experiments/utils.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9leHBlcmltZW50cy91dGlscy5weQ==) | `93.38% <ø> (ø)` | | | [skll/learner/\_\_init\_\_.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?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/learner/utils.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9sZWFybmVyL3V0aWxzLnB5) | `93.31% <ø> (ø)` | | | [skll/learner/voting.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9sZWFybmVyL3ZvdGluZy5weQ==) | `98.54% <ø> (ø)` | | | [skll/experiments/\_\_init\_\_.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9leHBlcmltZW50cy9fX2luaXRfXy5weQ==) | `94.69% <100.00%> (+0.01%)` | :arrow_up: | | [skll/experiments/output.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/739?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9leHBlcmltZW50cy9vdXRwdXQucHk=) | `97.46% <100.00%> (+0.01%)` | :arrow_up: |

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