willtebbutt commented 4 years ago

This PR clarifies what is supposed to happen with predict.

clarifies the docstring for predict to highlight what it should return, and that it should accept a collection of inputs, rather than a single input.
clarifies the documentation regarding the return type of predict for models that produce DistributionEstimates. This now reflects what we've actually been doing in BaselineModels, which I believe to be very reasonable.

codecov[bot] commented 4 years ago

Codecov Report

Merging #19 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #19   +/-   ##
=======================================
  Coverage   93.15%   93.15%           
=======================================
  Files           3        3           
  Lines          73       73           
=======================================
  Hits           68       68           
  Misses          5        5

Impacted Files	Coverage Δ
src/Models.jl	`100.00% <ø> (ø)`

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 9fa0caa...f3a6c79. Read the comment docs.

willtebbutt commented 4 years ago

Patch bumped. Will merge and tag once CI passes.

invenia / Models.jl

Clarify `predict` docs #19

Codecov Report