Merge pull request #83 from alan-turing-institute/dev

Add correct trait names to utilities for declaring trait values

Author: ablaom

src/metadata_utils.jl

@@ -25,37 +25,49 @@ a series of models.
 
 ## Keywords
 
-* `name="unknown"`   : package name
-* `uuid="unknown"`   : package uuid
-* `url="unknown"`    : package url
-* `julia=missing`    : whether the package is pure julia
-* `license="unknown"`: package license
+* `package_name="unknown"`   : package name
+* `package_uuid="unknown"`   : package uuid
+* `package_url="unknown"`    : package url
+* `is_pure_julia=missing`    : whether the package is pure julia
+* `package_license="unknown"`: package license
 * `is_wrapper=false` : whether the package is a wrapper
 
 ## Example
 
 ```
 metadata_pkg.((KNNRegressor, KNNClassifier),
-    name="NearestNeighbors",
-    uuid="b8a86587-4115-5ab1-83bc-aa920d37bbce",
-    url="https://github.com/KristofferC/NearestNeighbors.jl",
-    julia=true,
-    license="MIT",
+    package_name="NearestNeighbors",
+    package_uuid="b8a86587-4115-5ab1-83bc-aa920d37bbce",
+    package_url="https://github.com/KristofferC/NearestNeighbors.jl",
+    is_pure_julia=true,
+    package_license="MIT",
     is_wrapper=false)
 ```
 """
-function metadata_pkg(T; name::String="unknown",
-                         uuid::String="unknown",
-                         url::String="unknown",
-                         julia::Union{Missing,Bool}=missing,
-                         license::String="unknown",
-                         is_wrapper::Bool=false)
+function metadata_pkg(T;
+
+                      # aliases:
+                      name::String="unknown",
+                      uuid::String="unknown",
+                      url::String="unknown",
+                      julia::Union{Missing,Bool}=missing,
+                      license::String="unknown",
+                      is_wrapper::Bool=false,
+
+                      # preferred names, corresponding to trait names:
+                      package_name=name,
+                      package_uuid=uuid,
+                      package_url=url,
+                      is_pure_julia=julia,
+                      package_license=license,
+
+                      )
     ex = quote
-        MLJModelInterface.package_name(::Type{<:$T})    = $name
-        MLJModelInterface.package_uuid(::Type{<:$T})    = $uuid
-        MLJModelInterface.package_url(::Type{<:$T})     = $url
-        MLJModelInterface.is_pure_julia(::Type{<:$T})   = $julia
-        MLJModelInterface.package_license(::Type{<:$T}) = $license
+        MLJModelInterface.package_name(::Type{<:$T})    = $package_name
+        MLJModelInterface.package_uuid(::Type{<:$T})    = $package_uuid
+        MLJModelInterface.package_url(::Type{<:$T})     = $package_url
+        MLJModelInterface.is_pure_julia(::Type{<:$T})   = $is_pure_julia
+        MLJModelInterface.package_license(::Type{<:$T}) = $package_license
         MLJModelInterface.is_wrapper(::Type{<:$T})      = $is_wrapper
     end
     parentmodule(T).eval(ex)
@@ -68,44 +80,57 @@ Helper function to write the metadata for a model `T`.
 
 ## Keywords
 
-* `input=Unknown` : allowed scientific type of the input data
-* `target=Unknown`: allowed sc. type of the target (supervised)
-* `output=Unknown`: allowed sc. type of the transformed data (unsupervised)
-* `weights=false` : whether the model supports sample weights
-* `descr=""`      : short description of the model
-* `path=""`       : where the model is (usually `PackageName.ModelName`)
+* `input_scitype=Unknown` : allowed scientific type of the input data
+* `target_scitype=Unknown`: allowed sc. type of the target (supervised)
+* `output_scitype=Unknown`: allowed sc. type of the transformed data (unsupervised)
+* `supports_weights=false` : whether the model supports sample weights
+* `docstring=""`      : short description of the model
+* `load_path=""`       : where the model is (usually `PackageName.ModelName`)
 
 ## Example
 
 ```
 metadata_model(KNNRegressor,
-    input=MLJModelInterface.Table(MLJModelInterface.Continuous),
-    target=AbstractVector{MLJModelInterface.Continuous},
-    weights=true,
-    descr="K-Nearest Neighbors classifier: ...",
-    path="NearestNeighbors.KNNRegressor")
+    input_scitype=MLJModelInterface.Table(MLJModelInterface.Continuous),
+    target_scitype=AbstractVector{MLJModelInterface.Continuous},
+    supports_weights=true,
+    docstring="K-Nearest Neighbors classifier: ...",
+    load_path="NearestNeighbors.KNNRegressor")
 ```
 """
-function metadata_model(T; input=Unknown,
-                           target=Unknown,
-                           output=Unknown,
-                           weights::Bool=false,
-                           descr::String="",
-                           path::String="")
-    if isempty(path)
+function metadata_model(T;
+
+                        # aliases:
+                        input=Unknown,
+                        target=Unknown,
+                        output=Unknown,
+                        weights::Bool=false,
+                        descr::String="",
+                        path::String="",
+
+                        # preferred names, corresponding to trait names:
+                        input_scitype=input,
+                        target_scitype=target,
+                        output_scitype=output,
+                        supports_weights=weights,
+                        docstring=descr,
+                        load_path=path,
+
+                        )
+    if isempty(load_path)
         pname = MLJModelInterface.package_name(T)
         mname = MLJModelInterface.name(T)
-        path = "MLJModels.$(pname)_.$(mname)"
+        load_path = "MLJModels.$(pname)_.$(mname)"
     end
     ex = quote
-        MLJModelInterface.input_scitype(::Type{<:$T})    = $input
-        MLJModelInterface.output_scitype(::Type{<:$T})   = $output
-        MLJModelInterface.target_scitype(::Type{<:$T})   = $target
-        MLJModelInterface.supports_weights(::Type{<:$T}) = $weights
-        MLJModelInterface.load_path(::Type{<:$T})        = $path
+        MLJModelInterface.input_scitype(::Type{<:$T})    = $input_scitype
+        MLJModelInterface.output_scitype(::Type{<:$T})   = $output_scitype
+        MLJModelInterface.target_scitype(::Type{<:$T})   = $target_scitype
+        MLJModelInterface.supports_weights(::Type{<:$T}) = $supports_weights
+        MLJModelInterface.load_path(::Type{<:$T})        = $load_path
 
         MLJModelInterface.docstring(::Type{<:$T}) =
-            MLJModelInterface.docstring_ext($T; descr=$descr)
+            MLJModelInterface.docstring_ext($T; descr=$docstring)
     end
     parentmodule(T).eval(ex)
 end

test/data_utils.jl

@@ -63,7 +63,7 @@ end
     setlight()
     ary = rand(10, 3)
     @test_throws M.InterfaceError M.schema(ary)
-    df = DataFrame(rand(10, 3))
+    df = DataFrame(rand(10, 3), :auto)
     @test_throws M.InterfaceError M.schema(df)
 end
 @testset "schema-full" begin

test/model_traits.jl

@@ -73,7 +73,7 @@ struct Apple end
 
 end
 
-import .Banana
+import .Fruit
 
 @testset "extras" begin
     @test docstring(Float64) == "Float64"