Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 2.78 KB

model_search.md

File metadata and controls

110 lines (80 loc) · 2.78 KB
Raw

Model Search

MLJ has a model registry, allowing the user to search models and their properties, without loading all the packages containing model code. In turn, this allows one to efficiently find all models solving a given machine learning task. The task itself is specified with the help of the matching method, and the search executed with the models methods, as detailed below.

Model metadata

Terminology. In this section the word "model" refers to the metadata entry in the registry of an actual model struct, as appearing elsewhere in the manual. One can obtain such an entry with the info command:

using MLJ
MLJ.color_off()

info("PCA")

If two models with the same name occur in different packages, the package name must be specified, as in info("LinearRegressor", pkg="GLM").

General model queries

We list all models with models(), and list the models for which code is already loaded with localmodels():

localmodels()
localmodels()[2]

If models is passed any Bool-valued function test, it returns every model for which test(model) is true, as in

test(model) = model.is_supervised &&
                MLJ.Table(Continuous) <: model.input_scitype &&
                AbstractVector{<:Multiclass{3}} <: model.target_scitype &&
                model.prediction_type == :deterministic
models(test)

Multiple test arguments may be passed to models, which are applied conjunctively.

Matching models to data

!!! note The matching method described below is experimental and may break in subsequent MLJ releases.

Common searches are streamlined with the help of the matching command, defined as follows:

  • matching(model, X, y) == true exactly when model is supervised and admits inputs and targets with the scientific types of X and y, respectively

  • matching(model, X) == true exactly when model is unsupervised and admits inputs with the scientific types of X.

So, to search for all supervised probablistic models handling input X and target y, one can define the testing function task by

task(model) = matching(model, X, y)) && model.is_probabilistic

And execute the search with

models(task)

Also defined are Bool-valued callable objects matching(model), matching(X, y) and matching(X), with obvious behaviour. For example, matching(X, y)(model) = matching(model, X, y).

So, to search for all models compatible with input X and target y, for example, one executes

models(matching(X, y))

while the preceding search can also be written

models() do model
    matching(model, X, y) &&
    model.prediction_type == :probabilistic
end

API

models
localmodels
matching