Skip to content

Extension of bias-bench for select Sentence Transformers* models

Notifications You must be signed in to change notification settings

PrithivirajDamodaran/bias-bench

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Extending Bias-Bench for Sentence-Transformers

How to run the scripts to diagnose and debias sentence-transformers.

  • For benchmarking a Sentence Transformer model run ./experiments/seat.py with sentence-transformers/all-MiniLM-L6-v2 as the model
  • Formula for WEAT effect size given by Caliskan et al is in the image below (implementation is straightforward, see code)
  • Download and extract wikipedia-2.5.txt.zip in /data/text/ path of bias-bench repo
  • For getting debiased subspace run inlp_projection_matrix.py with specific bias types and model as sentence-transformers/all-MiniLM-L6-v2. Save the subspace files. This step needs nltk.download('punkt')
  • For debiasing specific bias types run seat_debias.py with respective subspace files created during previous step.
    • For gender run the following tests: sent-weat6 sent-weat6b sent-weat7 sent-weat7b sent-weat8 sent-weat8b
    • For race run the following tests: sent-weat3 sent-weat3b sent-weat4 sent-weat5 sent-weat5b sent-angry_black_woman_stereotype sent-angry_black_woman_stereotype_b
    • For religion run the following tests: sent-religion1 sent-religion1b sent-religion2 sent-religion2b
  • Optionally filter the results by significance level i.e p-value < 0.01
  • Calculate average of the absolute values to get avg.effect size.
  • Note: Currently only works for BERT or RoBERTA like models, the original implementation has not leveraged AutoModel implementation from HuggingFace. So if you want to test mpnet based model you need to add support for that model or include AutoModel support.

Fig 1


An Empirical Survey of the Effectiveness of Debiasing Techniques for Pre-trained Language Models

Nicholas Meade, Elinor Poole-Dayan, Siva Reddy

arxiv

This repository contains the official source code for An Empirical Survey of the Effectiveness of Debiasing Techniques for Pre-trained Language Models presented at ACL 2022.

Bias Bench Leaderboard

For tracking progress on the intrinsic bias benchmarks evaluated in this work, we created Bias Bench. We plan to update Bias Bench in the future with additional bias benchmarks. To make a submission to Bias Bench, please contact [email protected].

Install

git clone https://github.com/mcgill-nlp/bias-bench.git
cd bias-bench 
python -m pip install -e .

Required Datasets

Below, a list of the external datasets required by this repository is provided:

Dataset Download Link Notes Download Directory
Wikipedia-2.5 Download English Wikipedia dump used for SentenceDebias and INLP. data/text
Wikipedia-10 Download English Wikipedia dump used for CDA and Dropout. data/text

Each dataset should be downloaded to the specified path, relative to the root directory of the project.

Experiments

We provide scripts for running all of the experiments presented in the paper. Generally, each script takes a --model argument and a --model_name_or_path argument. We briefly describe the script(s) for each experiment below:

  • CrowS-Pairs: Two scripts are provided for evaluating models against CrowS-Pairs: experiments/crows.py evaluates non-debiased models against CrowS-Pairs and experiments/crows_debias.py evaluates debiased models against CrowS-Pairs.
  • INLP Projection Matrix: experiments/inlp_projection_matrix.py is used to compute INLP projection matrices.
  • SEAT: Two scripts are provided for evaluating models against SEAT: experiments/seat.py evaluates non-debiased models against SEAT and experiments/seat_debias.py evaluates debiased models against SEAT.
  • StereoSet: Two scripts are provided for evaluating models against StereoSet: experiments/stereoset.py evaluates non-debiased models against StereoSet and experiments/stereoset_debias.py evaluates debiased models against StereoSet.
  • SentenceDebias Subspace: experiments/sentence_debias_subspace.py is used to compute SentenceDebias subspaces.
  • GLUE: experiments/run_glue.py is used to run the GLUE benchmark.
  • Perplexity: experiments/perplexity.py is used to compute perplexities on WikiText-2.

For a complete list of options for each experiment, run each experiment script with the --h option. For example usages of these experiment scripts, refer to batch_jobs. The commands used in batch_jobs produce the results presented in the paper.

Notes

  • To run SentenceDebias models against any of the benchmarks, you will first need to run experiments/sentence_debias_subspace.py.
  • To run INLP models against any of the benchmarks, you will first need to run experiments/inlp_projection_matrix.py.
  • export contains a collection of scripts to format the results into the tables presented in the paper.

Running on an HPC Cluster

We provide scripts for running all of the experiments presented in the paper on a SLURM cluster in batch_jobs. If you plan to use these scripts, make sure you customize python_job.sh to run the jobs on your cluster. In addition, you will also need to change both the output (-o) and error (-e) paths.

Acknowledgements

This repository makes use of code from the following repositories:

We thank the authors for making their code publicly available.

Citation

If you use the code in this repository, please cite the following paper:

@inproceedings{meade_2022_empirical,
    title = "An Empirical Survey of the Effectiveness of Debiasing Techniques for Pre-trained Language Models",
    author = "Meade, Nicholas  and Poole-Dayan, Elinor  and Reddy, Siva",
    booktitle = "Proceedings of the 60th Annual Meeting of the Association for Computational Linguistics (Volume 1: Long Papers)",
    month = may,
    year = "2022",
    address = "Dublin, Ireland",
    publisher = "Association for Computational Linguistics",
    url = "https://aclanthology.org/2022.acl-long.132",
    doi = "10.18653/v1/2022.acl-long.132",
    pages = "1878--1898",
}

Releases

No releases published

Packages

No packages published

Languages

  • Python 79.8%
  • Shell 20.1%
  • Makefile 0.1%