report_fairness {mlr3fairness}

Create a Fairness Report

Description

Creates a new rmarkdown template with a skeleton of reported metrics and visualizations. Uses the awesome markdown template created by Chris Garbin from Github.

Usage

report_fairness(
  filename = "fairness_report.Rmd",
  objects,
  edit = FALSE,
  check_objects = FALSE,
  build = FALSE
)

Arguments

filename

(character(1))
File path or name for new file that should be created.

objects

(list())
A named list of objects required for the fairness report. Objects are saved as ⁠<name>.rds⁠ in the new folder created for the report.

• task :: The Task a report should be created for.

• resample_result :: A mlr3::ResampleResult result to be analyzed.

• ... :: any other objects passed on for the report.

edit

(logical(1))
TRUE to edit the template immediately.

check_objects

(logical(1))
Should items in objects be checked? If FALSE, no checks on object are performed.

build

(logical(1))
Should the report be built after creation? Initialized to FALSE.

Value

Invisibly returns the path to the newly created file(s).

See Also

Other fairness_reports: report_datasheet(), report_modelcard()

Examples

  library("mlr3")
  report_file = tempfile()
  task = tsk("compas")
  learner = lrn("classif.rpart", predict_type = "prob")
  rr = resample(task, learner, rsmp("cv", folds = 3L))
  report_fairness(report_file, list(task = task, resample_result = rr))