Skip to content

Commit

Permalink
Issue #38 (#39)
Browse files Browse the repository at this point in the history
* plot scale fix and regression

* description and fixes

* test and fixes

* update tests

* Bump version and update NEWS

* fix plot density

* Update links and descriptions

* add NEWS entry

* update README

* add seed
  • Loading branch information
jakwisn authored May 31, 2021
1 parent fea9bd1 commit 5668cb0
Show file tree
Hide file tree
Showing 31 changed files with 3,271 additions and 2,243 deletions.
68 changes: 34 additions & 34 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
Package: fairmodels
Type: Package
Title: Flexible Tool for Bias Detection, Visualization, and Mitigation
Version: 1.0.1
Authors@R:
c(person("Jakub", "Wiśniewski", role = c("aut", "cre"),
email = "jakwisn@gmail.com"),
person("Przemysław", "Biecek", role = c("aut"),
comment = c(ORCID = "0000-0001-8423-1823")))
Description: Measure fairness metrics in one place for many models. Check how big is model's bias towards different races, sex, nationalities etc. Use measures such as Statistical Parity, Equal odds to detect the discrimination against unprivileged groups. Visualize the bias using heatmap, radar plot, biplot, bar chart (and more!). There are various pre-processing and post-processing bias mitigation algorithms implemented. Find more details in (Wiśniewski, Biecek (2021)) <arXiv:2104.00507>.
License: GPL-3
Encoding: UTF-8
LazyData: true
Depends: R (>= 3.5)
Imports:
DALEX,
ggplot2,
patchwork,
ggdendro,
ggrepel,
scales
Suggests:
ranger,
gbm,
knitr,
rmarkdown,
covr,
testthat,
spelling
RoxygenNote: 7.1.1.9000
VignetteBuilder: knitr
URL: http://fairmodels.drwhy.ai/
BugReports: https://github.com/ModelOriented/fairmodels/issues
Language: en-US
Package: fairmodels
Type: Package
Title: Flexible Tool for Bias Detection, Visualization, and Mitigation
Version: 1.1.0
Authors@R:
c(person("Jakub", "Wiśniewski", role = c("aut", "cre"),
email = "jakwisn@gmail.com"),
person("Przemysław", "Biecek", role = c("aut"),
comment = c(ORCID = "0000-0001-8423-1823")))
Description: Measure fairness metrics in one place for many models. Check how big is model's bias towards different races, sex, nationalities etc. Use measures such as Statistical Parity, Equal odds to detect the discrimination against unprivileged groups. Visualize the bias using heatmap, radar plot, biplot, bar chart (and more!). There are various pre-processing and post-processing bias mitigation algorithms implemented. Package also supports calculating fairness metrics for regression models. Find more details in (Wiśniewski, Biecek (2021)) <arXiv:2104.00507>.
License: GPL-3
Encoding: UTF-8
LazyData: true
Depends: R (>= 3.5)
Imports:
DALEX,
ggplot2,
patchwork,
ggdendro,
ggrepel,
scales
Suggests:
ranger,
gbm,
knitr,
rmarkdown,
covr,
testthat,
spelling
RoxygenNote: 7.1.1.9001
VignetteBuilder: knitr
URL: https://fairmodels.drwhy.ai/
BugReports: https://github.com/ModelOriented/fairmodels/issues
Language: en-US
136 changes: 71 additions & 65 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,65 +1,71 @@
# Generated by roxygen2: do not edit by hand

S3method(plot,all_cutoffs)
S3method(plot,ceteris_paribus_cutoff)
S3method(plot,chosen_metric)
S3method(plot,fairness_heatmap)
S3method(plot,fairness_object)
S3method(plot,fairness_pca)
S3method(plot,fairness_radar)
S3method(plot,group_metric)
S3method(plot,metric_scores)
S3method(plot,performance_and_fairness)
S3method(plot,stacked_metrics)
S3method(plot_fairmodels,default)
S3method(plot_fairmodels,explainer)
S3method(plot_fairmodels,fairness_object)
S3method(print,all_cutoffs)
S3method(print,ceteris_paribus_cutoff)
S3method(print,chosen_metric)
S3method(print,fairness_heatmap)
S3method(print,fairness_object)
S3method(print,fairness_pca)
S3method(print,fairness_radar)
S3method(print,group_metric)
S3method(print,metric_scores)
S3method(print,performance_and_fairness)
S3method(print,stacked_metrics)
export(all_cutoffs)
export(calculate_group_fairness_metrics)
export(ceteris_paribus_cutoff)
export(choose_metric)
export(confusion_matrix)
export(disparate_impact_remover)
export(expand_fairness_object)
export(fairness_check)
export(fairness_heatmap)
export(fairness_pca)
export(fairness_radar)
export(group_matrices)
export(group_metric)
export(group_model_performance)
export(metric_scores)
export(performance_and_fairness)
export(plot_density)
export(plot_fairmodels)
export(pre_process_data)
export(resample)
export(reweight)
export(roc_pivot)
export(stack_metrics)
import(ggplot2)
import(patchwork)
importFrom(DALEX,model_performance)
importFrom(DALEX,theme_drwhy)
importFrom(DALEX,theme_drwhy_vertical)
importFrom(ggdendro,dendro_data)
importFrom(ggdendro,segment)
importFrom(ggrepel,geom_text_repel)
importFrom(stats,dist)
importFrom(stats,ecdf)
importFrom(stats,hclust)
importFrom(stats,median)
importFrom(stats,na.omit)
importFrom(stats,quantile)
importFrom(utils,head)
# Generated by roxygen2: do not edit by hand

S3method(plot,all_cutoffs)
S3method(plot,ceteris_paribus_cutoff)
S3method(plot,chosen_metric)
S3method(plot,fairness_heatmap)
S3method(plot,fairness_object)
S3method(plot,fairness_pca)
S3method(plot,fairness_radar)
S3method(plot,fairness_regression_object)
S3method(plot,group_metric)
S3method(plot,metric_scores)
S3method(plot,performance_and_fairness)
S3method(plot,stacked_metrics)
S3method(plot_fairmodels,default)
S3method(plot_fairmodels,explainer)
S3method(plot_fairmodels,fairness_object)
S3method(print,all_cutoffs)
S3method(print,ceteris_paribus_cutoff)
S3method(print,chosen_metric)
S3method(print,fairness_heatmap)
S3method(print,fairness_object)
S3method(print,fairness_pca)
S3method(print,fairness_radar)
S3method(print,fairness_regression_object)
S3method(print,group_metric)
S3method(print,metric_scores)
S3method(print,performance_and_fairness)
S3method(print,stacked_metrics)
export(all_cutoffs)
export(calculate_group_fairness_metrics)
export(ceteris_paribus_cutoff)
export(choose_metric)
export(confusion_matrix)
export(disparate_impact_remover)
export(expand_fairness_object)
export(fairness_check)
export(fairness_check_regression)
export(fairness_heatmap)
export(fairness_pca)
export(fairness_radar)
export(group_matrices)
export(group_metric)
export(group_model_performance)
export(metric_scores)
export(performance_and_fairness)
export(plot_density)
export(plot_fairmodels)
export(pre_process_data)
export(regression_metrics)
export(resample)
export(reweight)
export(roc_pivot)
export(stack_metrics)
import(ggplot2)
import(patchwork)
importFrom(DALEX,model_performance)
importFrom(DALEX,theme_drwhy)
importFrom(DALEX,theme_drwhy_vertical)
importFrom(ggdendro,dendro_data)
importFrom(ggdendro,segment)
importFrom(ggrepel,geom_text_repel)
importFrom(stats,binomial)
importFrom(stats,dist)
importFrom(stats,ecdf)
importFrom(stats,glm)
importFrom(stats,hclust)
importFrom(stats,median)
importFrom(stats,na.omit)
importFrom(stats,quantile)
importFrom(utils,head)
18 changes: 13 additions & 5 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# fairmodels 1.1.0
* Added function `fairness_check_regression()` that supports regression models along with 2 plot types [(#38)](https://github.com/ModelOriented/fairmodels/issues/38).
* Added additional tests.
* Modularized `fairness_check()` code.
* Changed x-axis ticks generation in `fairness_check()`.
* Fixed issues with `plot_density
* Updated links in README and DESCRIPTION.

# fairmodels 1.0.1
* Changed examples - added parameter `num.threads = 1` to `ranger` and added *donttest{}* to examples with long computation time.

Expand All @@ -7,20 +15,20 @@
* Fixed links in DESCRIPTION and README.

# fairmodels 0.2.6
* Fixed bug which appeared when two fairness objects were passed to `fairness_check` without an explainer. (#36)
* Fixed bug which appeared when two fairness objects were passed to `fairness_check` without an explainer. [(#36)](https://github.com/ModelOriented/fairmodels/issues/36)

# fairmodels 0.2.5
* Extended documentation for `epsilon` parameter in `fairness_check()` function.

# fairmodels 0.2.4
* Deleted on-load information message about four-fifths rule.
* Fixed bug with `NA` warning in metrics that are not chosen. (#32)
* Fixed bug with `NA` warning in metrics that are not chosen. [(#32)](https://github.com/ModelOriented/fairmodels/issues/32)

# fairmodels 0.2.3
* Fixed the way the `parity_loss` is calculated in `all_cutoffs` and `ceteris_paribus_cutoff`. (#24)
* Fixed the way the `parity_loss` is calculated in `all_cutoffs` and `ceteris_paribus_cutoff`. [(#24)](https://github.com/ModelOriented/fairmodels/issues/24)
* Updated vignettes
* changed documentation of functions to explicitly state metrics instead of `fairness_check_metrics()`. (#29)
* Fixed typos (#27 and #28)
* changed documentation of functions to explicitly state metrics instead of `fairness_check_metrics()`. [(#29)](https://github.com/ModelOriented/fairmodels/issues/29)
* Fixed typos ([#27](https://github.com/ModelOriented/fairmodels/issues/27) and [#28](https://github.com/ModelOriented/fairmodels/issues/28))
* Changed conclusion drawn from density plot in `Basic Tutorial` (#26)

# fairmodels 0.2.2
Expand Down
Loading

0 comments on commit 5668cb0

Please sign in to comment.