list_learners: Learner inventory table with capabilities.

View source: R/fit.R

list_learnersR Documentation

Learner inventory table with capabilities.

Description

list_learners() returns a compact learner registry in the style of a catalog table. By default it focuses on the most user-visible columns: learner id, generic fit/predict/tune entry points, and availability in the current session.

Usage

list_learners(
  has_fit = NULL,
  has_predict = NULL,
  has_tune = NULL,
  available = NULL,
  columns = NULL,
  regression = NULL,
  classification = NULL,
  prob = NULL,
  multiclass = NULL,
  importance = NULL,
  tune = NULL
)

Arguments

has_fit

Optional logical filter for fit support.

has_predict

Optional logical filter for predict support.

has_tune

Optional logical filter for tuning support.

available

Optional logical filter for engine availability in the current session.

columns

Optional character vector of columns to return.

regression

Optional logical filter for regression support.

classification

Optional logical filter for classification support.

prob

Optional logical filter for probability support.

multiclass

Optional logical filter for multiclass support.

importance

Optional logical filter for feature-importance support.

tune

Deprecated alias for has_tune.

Details

Additional capability metadata remains available through ⁠columns =⁠.

Value

Data frame with learner metadata and capability columns.

Examples

list_learners()
list_learners(has_tune = TRUE)
list_tunable_learners()
list_learners(classification = TRUE, prob = TRUE,
              columns = c("learner", "has_tune", "supports_prob", "engine_package"))

funcml documentation built on Aug. 22, 2026, 5:08 p.m.