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

Feature/rewrite docstrings skll data featureset #685

Closed RobertImbrie closed 3 years ago

RobertImbrie commented 3 years ago

Notes: Sci-Kit Learn's documentation sometimes formats array shapes as: example_array, shape (label1, label2)

Sometimes it formats array shapes as: example_array of shape (label1, label2)

I used the second option because it reduces ambiguity. Otherwise, if a parameter takes multiple data types, it's sometimes unclear which data type has the shape.

codecov[bot] commented 3 years ago

Codecov Report

Merging #685 (afa70fb) into main (8380016) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #685   +/-   ##
=======================================
  Coverage   96.85%   96.85%           
=======================================
  Files          63       63           
  Lines        9098     9098           
=======================================
  Hits         8812     8812           
  Misses        286      286           
Impacted Files Coverage Δ
skll/data/featureset.py 90.50% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 8380016...afa70fb. Read the comment docs.