[R] Rename aif_dataset function

Signed-off-by: milevavantuyl <[email protected]>
Trusted-AI · Jun 27, 2022 · 44b09cf · 44b09cf
1 parent dc93bc0
commit 44b09cf
Show file tree

Hide file tree

Showing 18 changed files with 29 additions and 29 deletions.
diff --git a/aif360/aif360-r/NAMESPACE b/aif360/aif360-r/NAMESPACE
@@ -2,8 +2,8 @@
 
 export(adult_dataset)
 export(adversarial_debiasing)
-export(aif_dataset)
 export(bank_dataset)
+export(binary_label_dataset)
 export(binary_label_dataset_metric)
 export(classification_metric)
 export(compas_dataset)

diff --git a/aif360/aif360-r/R/classification_metric.R b/aif360/aif360-r/R/classification_metric.R
@@ -13,14 +13,14 @@
 #' # Input dataset
 #' data <- data.frame("feat" = c(0,0,1,1,1,1,0,1,1,0), "label" = c(1,0,0,1,0,0,1,0,1,1))
 #' # Create aif compatible input dataset
-#' act <- aif360::aif_dataset(data_path = data,  favor_label=0, unfavor_label=1,
+#' act <- aif360::binary_label_dataset(data_path = data,  favor_label=0, unfavor_label=1,
 #'                             unprivileged_protected_attribute=0,
 #'                             privileged_protected_attribute=1,
 #'                             target_column="label", protected_attribute="feat")
 #' # Classified dataset
 #' pred_data <- data.frame("feat" = c(0,0,1,1,1,1,0,1,1,0), "label" = c(1,0,1,1,1,0,1,0,0,1))
 #' # Create aif compatible classified dataset
-#' pred <- aif360::aif_dataset(data_path = pred_data,  favor_label=0, unfavor_label=1,
+#' pred <- aif360::binary_label_dataset(data_path = pred_data,  favor_label=0, unfavor_label=1,
 #'                              unprivileged_protected_attribute=0,
 #'                              privileged_protected_attribute=1,
 #'                              target_column="label", protected_attribute="feat")

diff --git a/aif360/aif360-r/R/dataset.R b/aif360/aif360-r/R/dataset.R
@@ -9,7 +9,7 @@
 #' @param target_column Name describing the label.
 #' @param protected_attribute A feature for which fairness is desired.
 #' @usage
-#' aif_dataset(data_path,  favor_label, unfavor_label,
+#' binary_label_dataset(data_path,  favor_label, unfavor_label,
 #'                      unprivileged_protected_attribute,
 #'                      privileged_protected_attribute,
 #'                      target_column, protected_attribute)
@@ -19,7 +19,7 @@
 #' # Input dataset
 #' data <- data.frame("feat" = c(0,0,1,1,1,1,0,1,1,0), "label" = c(1,0,0,1,0,0,1,0,1,1))
 #' # Create aif compatible input dataset
-#' act <- aif360::aif_dataset(data_path = data,  favor_label=0, unfavor_label=1,
+#' act <- aif360::binary_label_dataset(data_path = data,  favor_label=0, unfavor_label=1,
 #'                             unprivileged_protected_attribute=0,
 #'                             privileged_protected_attribute=1,
 #'                             target_column="label", protected_attribute="feat")
@@ -30,7 +30,7 @@
 #' @importFrom reticulate py_suppress_warnings py_dict r_to_py
 #' @importFrom utils file_test
 #'
-aif_dataset <- function(data_path, favor_label,
+binary_label_dataset <- function(data_path, favor_label,
                         unfavor_label, unprivileged_protected_attribute,
                         privileged_protected_attribute,
                         target_column, protected_attribute) {

diff --git a/aif360/aif360-r/R/dataset_metric.R b/aif360/aif360-r/R/dataset_metric.R
@@ -12,7 +12,7 @@
 #' load_aif360_lib()
 #' data <- data.frame("feat" = c(0,0,1,1,1,1,0,1,1,0), "label" = c(1,0,0,1,0,0,1,0,1,1))
 #' # Create aif compatible dataset
-#' dd <- aif360::aif_dataset(data_path = data,
+#' dd <- aif360::binary_label_dataset(data_path = data,
 #'                            favor_label=0, unfavor_label=1,
 #'                             unprivileged_protected_attribute=0,
 #'                             privileged_protected_attribute=1,

diff --git a/aif360/aif360-r/R/postprocessing_reject_option_classification.R b/aif360/aif360-r/R/postprocessing_reject_option_classification.R
@@ -34,11 +34,11 @@
 #' ad_df_pred$label <- as.character(ad_pred)
 #' colnames(ad_df_pred) <- c(ad$feature_names, 'label')
 #'
-#' ad_ds <- aif_dataset(ad_df, target_column='label', favor_label = 1,
+#' ad_ds <- binary_label_dataset(ad_df, target_column='label', favor_label = 1,
 #'                      unfavor_label = 0, unprivileged_protected_attribute = 0,
 #'                      privileged_protected_attribute = 1, protected_attribute='race')
 #'
-#' ad_ds_pred <- aif_dataset(ad_df_pred, target_column='label', favor_label = 1,
+#' ad_ds_pred <- binary_label_dataset(ad_df_pred, target_column='label', favor_label = 1,
 #'                unfavor_label = 0, unprivileged_protected_attribute = 0,
 #'                privileged_protected_attribute = 1, protected_attribute='race')
 #'

diff --git a/aif360/aif360-r/README.Rmd b/aif360/aif360-r/README.Rmd
@@ -120,7 +120,7 @@ data <- data.frame("feature1" = c(0,0,1,1,1,1,0,1,1,0),
                    "label" = c(1,0,0,1,0,0,1,0,1,1))
 
 # format the dataset
-formatted_dataset <- aif360::aif_dataset(data_path = data,
+formatted_dataset <- aif360::binary_label_dataset(data_path = data,
                                           favor_label = 0,
                                           unfavor_label = 1,
                                           unprivileged_protected_attribute = 0,

diff --git a/aif360/aif360-r/README.md b/aif360/aif360-r/README.md
@@ -120,7 +120,7 @@ data <- data.frame("feature1" = c(0,0,1,1,1,1,0,1,1,0),
                    "label" = c(1,0,0,1,0,0,1,0,1,1))
 
 # format the dataset
-formatted_dataset <- aif360::aif_dataset(data_path = data,
+formatted_dataset <- aif360::binary_label_dataset(data_path = data,
                                           favor_label = 0,
                                           unfavor_label = 1,
                                           unprivileged_protected_attribute = 0,

diff --git a/aif360/aif360-r/inst/examples/test.R b/aif360/aif360-r/inst/examples/test.R
@@ -6,7 +6,7 @@ load_aif360_lib()
 
 
 
-dd <- aif360::aif_dataset(
+dd <- aif360::binary_label_dataset(
   data_path = system.file("extdata", "data.csv", package="aif360"),
   favor_label=0,
   unfavor_label=1,

diff --git a/aif360/aif360-r/man/aif_dataset.Rd → aif360/aif360-r/man/binary_label_dataset.Rd b/aif360/aif360-r/man/aif_dataset.Rd → aif360/aif360-r/man/binary_label_dataset.Rd
diff --git a/aif360/aif360-r/man/classification_metric.Rd b/aif360/aif360-r/man/classification_metric.Rd
diff --git a/aif360/aif360-r/man/reject_option_classification.Rd b/aif360/aif360-r/man/reject_option_classification.Rd
diff --git a/aif360/aif360-r/tests/testthat/test-adversarial.R b/aif360/aif360-r/tests/testthat/test-adversarial.R
@@ -2,7 +2,7 @@ context("Comprehensive Test for Inprocessing Adversarial DebiasingAlgorithm")
 
 
 test_that("running dataset test", {
-  dd <- aif360::aif_dataset(
+  dd <- aif360::binary_label_dataset(
     data_path = system.file("extdata", "data.csv", package="aif360"),
     favor_label=0,
     unfavor_label=1,
@@ -11,7 +11,7 @@ test_that("running dataset test", {
     target_column="income",
     protected_attribute="sex")
 
-  pred <- aif360::aif_dataset(
+  pred <- aif360::binary_label_dataset(
     data_path = system.file("extdata", "actual_data.csv", package="aif360"),
     favor_label=1,
     unfavor_label=0,

diff --git a/aif360/aif360-r/tests/testthat/test-binary-dataset-metrics.R b/aif360/aif360-r/tests/testthat/test-binary-dataset-metrics.R
@@ -3,7 +3,7 @@ context("Comprehensive Test for Binary Label Dataset Metric")
 
 test_that("running dataset test", {
 
-  dd <- aif360::aif_dataset(
+  dd <- aif360::binary_label_dataset(
     data_path = system.file("extdata", "data.csv", package="aif360"),
     favor_label=0,
     unfavor_label=1,

diff --git a/aif360/aif360-r/tests/testthat/test-classification.R b/aif360/aif360-r/tests/testthat/test-classification.R
@@ -3,7 +3,7 @@ context("Comprehensive Test for Classification Metric")
 
 test_that("running dataset test", {
 
-  act <- aif360::aif_dataset(
+  act <- aif360::binary_label_dataset(
     data_path = system.file("extdata", "actual_data.csv", package="aif360"),
     favor_label=1,
     unfavor_label=0,
@@ -12,7 +12,7 @@ test_that("running dataset test", {
     target_column="income",
     protected_attribute="sex")
 
-  pred <- aif360::aif_dataset(
+  pred <- aif360::binary_label_dataset(
     data_path = system.file("extdata", "predicted_data.csv", package="aif360"),
     favor_label=1,
     unfavor_label=0,

diff --git a/aif360/aif360-r/tests/testthat/test-dataset.R b/aif360/aif360-r/tests/testthat/test-dataset.R
@@ -3,7 +3,7 @@ context("Comprehensive Test for Binary Dataset Creation")
 
 test_that("running dataset test", {
 
-  dd <- aif360::aif_dataset(
+  dd <- aif360::binary_label_dataset(
     data_path = system.file("extdata", "data.csv", package="aif360"),
     favor_label=0,
     unfavor_label=1,

diff --git a/aif360/aif360-r/tests/testthat/test-disparate-impact-remover.R b/aif360/aif360-r/tests/testthat/test-disparate-impact-remover.R
@@ -2,7 +2,7 @@ context("Comprehensive Test for Disparate Impact Remover Algorithm")
 
 
 test_that("running dataset test", {
-  dd <- aif360::aif_dataset(
+  dd <- aif360::binary_label_dataset(
     data_path = system.file("extdata", "data.csv", package="aif360"),
     favor_label=0,
     unfavor_label=1,

diff --git a/aif360/aif360-r/tests/testthat/test-prejudice-remover.R b/aif360/aif360-r/tests/testthat/test-prejudice-remover.R
@@ -2,7 +2,7 @@ context("Comprehensive Test for Prejudice Remover Algorithm")
 
 
 test_that("running prejudice remover test", {
-  dd <- aif360::aif_dataset(
+  dd <- aif360::binary_label_dataset(
     data_path = system.file("extdata", "data.csv", package="aif360"),
     favor_label=0,
     unfavor_label=1,

diff --git a/aif360/aif360-r/tests/testthat/test-reweighing.R b/aif360/aif360-r/tests/testthat/test-reweighing.R
@@ -2,7 +2,7 @@ context("Comprehensive Test for Preprocessing Reweighing Algorithm")
 
 
 test_that("running dataset test", {
-  dd <- aif360::aif_dataset(
+  dd <- aif360::binary_label_dataset(
     data_path = system.file("extdata", "data.csv", package="aif360"),
     favor_label=0,
     unfavor_label=1,