Merge pull request #85 from alan-turing-institute/traits

Get model traits from new package StatisticalTraits.jl

Author: ablaom

Project.toml

@@ -1,15 +1,17 @@
 name = "MLJModelInterface"
 uuid = "e80e1ace-859a-464e-9ed9-23947d8ae3ea"
 authors = ["Thibaut Lienart and Anthony Blaom"]
-version = "0.3.8"
+version = "0.3.9"
 
 [deps]
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 ScientificTypes = "321657f4-b219-11e9-178b-2701a2544e81"
+StatisticalTraits = "64bff920-2084-43da-a3e6-9bb72801c0c9"
 
 [compat]
 ScientificTypes = "^1"
-julia = "1"
+StatisticalTraits = "^0.1"
+julia = "^1"
 
 [extras]
 CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"

src/MLJModelInterface.jl

@@ -1,8 +1,32 @@
 module MLJModelInterface
 
+const MODEL_TRAITS = [
+    :input_scitype,
+    :output_scitype,
+    :target_scitype,
+    :is_pure_julia,
+    :package_name,
+    :package_license,
+    :load_path,
+    :package_uuid,
+    :package_url,
+    :is_wrapper,
+    :supports_weights,
+    :supports_class_weights,
+    :supports_online,
+    :docstring,
+    :name,
+    :is_supervised,
+    :prediction_type,
+    :implemented_methods,
+    :hyperparameters,
+    :hyperparameter_types,
+    :hyperparameter_ranges]
+
 # ------------------------------------------------------------------------
-# Dependencies (ScientificTypes itself does not have dependencies)
+# Dependencies (ScientificTypes and StatisticalTraits have none)
 using ScientificTypes
+using StatisticalTraits
 using Random
 
 # ------------------------------------------------------------------------
@@ -28,13 +52,9 @@ export fit, update, update_data, transform, inverse_transform,
     predict_joint, evaluate, clean!, reformat
 
 # model traits
-export input_scitype, output_scitype, target_scitype,
-       is_pure_julia, package_name, package_license,
-       load_path, package_uuid, package_url,
-       is_wrapper, supports_weights, supports_online,
-       docstring, name, is_supervised,
-       prediction_type, implemented_methods, hyperparameters,
-       hyperparameter_types, hyperparameter_ranges
+for trait in MODEL_TRAITS
+    @eval(export $trait)
+end
 
 # data operations
 export matrix, int, classes, decoder, table,
@@ -93,7 +113,6 @@ abstract type JointProbabilistic <: Probabilistic end
 # ------------------------------------------------------------------------
 # includes
 
-include("utils.jl")
 include("parameter_inspection.jl")
 include("data_utils.jl")
 include("metadata_utils.jl")

src/model_traits.jl

@@ -1,60 +1,18 @@
-## MODEL TRAITS
+## OVERLOADING TRAIT DEFAULTS RELEVANT TO MODELS
 
-# model trait names:
-const MODEL_TRAITS = [
-    :input_scitype, :output_scitype, :target_scitype,
-    :is_pure_julia, :package_name, :package_license,
-    :load_path, :package_uuid, :package_url,
-    :is_wrapper, :supports_weights, :supports_online,
-    :docstring, :name, :is_supervised,
-    :prediction_type, :implemented_methods, :hyperparameters,
-    :hyperparameter_types, :hyperparameter_ranges]
+StatisticalTraits.docstring(M::Type{<:MLJType}) = name(M)
+StatisticalTraits.docstring(M::Type{<:Model}) =
+    "$(name(M)) from $(package_name(M)).jl.\n" *
+    "[Documentation]($(package_url(M)))."
 
-for trait in MODEL_TRAITS
-    ex = quote
-        $trait(x) = $trait(typeof(x))
-    end
-    MLJModelInterface.eval(ex)
-end
-
-# fallback trait declarations:
-input_scitype(::Type)          = Unknown
-output_scitype(::Type)         = Unknown
-target_scitype(::Type)         = Unknown  # used for measures too
-is_pure_julia(::Type)          = false
-package_name(::Type)           = "unknown"
-package_license(::Type)        = "unknown"
-load_path(::Type)              = "unknown"
-package_uuid(::Type)           = "unknown"
-package_url(::Type)            = "unknown"
-is_wrapper(::Type)             = false
-supports_online(::Type)        = false
-supports_weights(::Type)       = false  # used for measures too
-hyperparameter_ranges(T::Type) = Tuple(fill(nothing, length(fieldnames(T))))
-docstring(M::Type)             = string(M)
-docstring(M::Type{<:MLJType})  = name(M)
-docstring(M::Type{<:Model})    = "$(name(M)) from $(package_name(M)).jl.\n" *
-                                 "[Documentation]($(package_url(M)))."
-# "derived" traits:
-function _coretype(M)
-    if isdefined(M, :name)
-        return M.name.name
-    else
-        return _coretype(M.body)
-    end
-end
-name(M::Type)                            = string(_coretype(M))
-is_supervised(::Type)                    = false
-is_supervised(::Type{<:Supervised})      = true
-prediction_type(::Type)                  = :unknown # used for measures too
-prediction_type(::Type{<:Deterministic}) = :deterministic
-prediction_type(::Type{<:Probabilistic}) = :probabilistic
-prediction_type(::Type{<:Interval})      = :interval
-hyperparameters(M::Type)                 = fieldnames(M)
-hyperparameter_types(M::Type)            = string.(fieldtypes(M))
+StatisticalTraits.is_supervised(::Type{<:Supervised})      = true
+StatisticalTraits.prediction_type(::Type{<:Deterministic}) = :deterministic
+StatisticalTraits.prediction_type(::Type{<:Probabilistic}) = :probabilistic
+StatisticalTraits.prediction_type(::Type{<:Interval})      = :interval
 
 # implementation is deferred as it requires methodswith which depends upon
 # InteractiveUtils which we don't want to bring here as a dependency
 # (even if it's stdlib).
 implemented_methods(M::Type) = implemented_methods(get_interface_mode(), M)
+implemented_methods(model) = implemented_methods(typeof(model))
 implemented_methods(::LightInterface, M) = errlight("implemented_methods")

src/utils.jl

@@ -69,7 +69,6 @@ module Fruit
 import MLJModelInterface.MLJType
 
 struct Banana <: MLJType end
-struct Apple end
 
 end
 
@@ -78,13 +77,4 @@ import .Fruit
 @testset "extras" begin
     @test docstring(Float64) == "Float64"
     @test docstring(Fruit.Banana) == "Banana"
-    @test name(Float64) == "Float64"
-
-    df = DataFrame(a=randn(2), b=randn(2))
-    @test M.name(typeof(df)) == "DataFrame"
-    @test M.name(df) == "DataFrame"
-    @test M.name(Fruit.Banana) == "Banana"
-    @test M.name(Fruit.Banana()) == "Banana"
-    @test M.name(Fruit.Apple) == "Apple"
-    @test M.name(Fruit.Apple()) == "Apple"
 end