Conventions for MLModels Implementation

Brian J Smith

2021-07-23

Model Constructor Components

Constructor Arguments

name Slot

packages Slot

response_types Slot

weights Slot

params Slot

fit Function

if(!all(weights == 1)) warning("weights are not supported and will be ignored")

predict Function

varimp Function

Documenting an MLModel

Model Parameters

Details Section

Default values for the arguments and further model details can be found in the source link below.

Return (Value) Section

MLModel class object.

See Also Section

\code{\link[<source package>]{<fit function>}}, \code{\link{fit}},
\code{\link{resample}}

Package Extensions