Skip to content

indicating case weight support in show_model_info() #1000

Closed
@simonpcouch

Description

@simonpcouch

From #996:

library(tidymodels)

# custom model info:
set_new_model("discrim_mixture")
set_model_mode(model = "discrim_mixture", mode = "classification")
set_model_engine(
  "discrim_mixture", 
  mode = "classification", 
  eng = "mda"
)
set_dependency("discrim_mixture", eng = "mda", pkg = "mda")

show_model_info("discrim_mixture")
#> Information for `discrim_mixture`
#>  modes: unknown, classification 
#> 
#>  engines: 
#>    classification: mdaNA
#> 
#> ¹The model can use case weights.
#> 
#>  no registered arguments.
#> 
#>  no registered fit modules.
#> 
#>  no registered prediction modules.

show_model_info("linear_reg")
#> Information for `linear_reg`
#>  modes: unknown, regression 
#> 
#>  engines: 
#>    regression: brulee, glm¹, glmnet¹, keras, lm¹, spark¹, stan¹
#> 
#> ¹The model can use case weights.
#> 
#>  [truncated output for clarity]

Created on 2023-09-14 with reprex v2.0.2

"¹The model can use case weights." means that only engines with the superscripted 1 can use case weights. In cases where some engines can support case weights, the notation is clear, but when there's no case weight support for any engine (and thus no superscripted 1 previouslt), that footnote seems like it's saying that every engine used with the model can use case weights. We ought to fix that—I'll open up a separate issue.

Originally posted by @simonpcouch in #996 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions