report_modelcard

Creates a new <a href="https://CRAN.R-project.org/package=rmarkdown">rmarkdown</a> template with a skeleton questionnaire for a model card.
Uses the awesome markdown template created by Chris Garbin
<a href="https://github.com/fau-masters-collected-works-cgarbin/model-card-template">from Github</a>.

Integrates fairness auditing and bias mitigation methods for
the 'mlr3' ecosystem. This includes fairness metrics, reporting
tools, visualizations and bias mitigation techniques such as
"Reweighing" described in 'Kamiran, Calders' (2012)
<doi:10.1007/s10115-011-0463-8> and "Equalized Odds" described in
'Hardt et al.' (2016)
<https://papers.nips.cc/paper/2016/file/9d2682367c3935defcb1f9e247a97c0d-Paper.pdf>.
Integration with 'mlr3' allows for auditing of ML models as well as
convenient joint tuning of machine learning algorithms and debiasing
methods.

Florian Pfisterer

mlr3fairness

Fairness Auditing and Debiasing for 'mlr3'

Wei Siyi

Michel Lang

report_modelcard function

<dl><dt>filename</dt>
<dd>(<code>character(1)</code>) 
File path or name for new file that should be created.</dd>
<dt>edit</dt>
<dd>(<code>logical(1)</code>) 
<code>TRUE</code> to edit the template immediately.</dd>
<dt>build</dt>
<dd>(<code>logical(1)</code>) 
Should the report be built after creation? Initialized to <code>FALSE</code>.</dd></dl>

Arguments

Creates a new <a href='https://CRAN.R-project.org/package=rmarkdown'>rmarkdown</a> template with a skeleton questionnaire for a model card.
Uses the awesome markdown template created by Chris Garbin
<a href='https://github.com/fau-masters-collected-works-cgarbin/model-card-template'>from Github</a>.

Create a Modelcard — report_modelcard

<dl>

<dt>filename</dt>
<dd>(<code>character(1)</code>) 
File path or name for new file that should be created.</dd>


<dt>edit</dt>
<dd>(<code>logical(1)</code>) 
<code>TRUE</code> to edit the template immediately.</dd>


<dt>build</dt>
<dd>(<code>logical(1)</code>) 
Should the report be built after creation? Initialized to <code>FALSE</code>.</dd>

</dl>

report_modelcard: Create a Modelcard

Description

Usage

Value

Arguments

References

See Also

Examples