Bugfix masking uppercase pronouns. Update docs, examples. Parity with emilylearning

app.py

@@ -153,7 +153,7 @@ def get_gendered_token_ids():
 
 def prepare_text_for_masking(input_text, mask_token, gendered_tokens, split_key):
     text_w_masks_list = [
-        mask_token if word in gendered_tokens else word for word in input_text.split()]
+        mask_token if word.lower() in gendered_tokens else word for word in input_text.split()]
     num_masks = len([m for m in text_w_masks_list if m == mask_token])
 
     text_portions = ' '.join(text_w_masks_list).split(split_key)
@@ -297,7 +297,7 @@ place_example = [
     'PLACE',
     "False",
     1,
-    'Born in PLACE, she was a teacher.'
+    'She was raised in PLACE.'
 ]
 
 date_example = [
@@ -307,7 +307,7 @@ date_example = [
     'DATE',
     "False",
     3,
-    'Born in DATE, she was a doctor.'
+    'She was a teenager in DATE.'
 ]
 
 
@@ -317,8 +317,8 @@ subreddit_example = [
     ', '.join(SUBREDDITS),
     'SUBREDDIT',
     "False",
-    3,
-    'I saw in r/SUBREDDIT that she is a hacker.'
+    1,
+    'I saw in r/SUBREDDIT that she was born in 1911.'
 ]
 
 own_model_example = [
@@ -354,10 +354,6 @@ with demo:
     gr.Markdown("## Spurious Correlation Evaluation for Pre-trained and Fine-tuned LLMs")
     gr.Markdown("Although genders are relatively evenly distributed across time, place and interests, there are also known gender disparities in terms of access to resources. Here we demonstrate that this access disparity can result in dataset selection bias, causing models to learn a surprising range of spurious associations.")
    
-    gr.Markdown("### Dose-response Relationship")
-    gr.Markdown("One intuitive way to see the impact that changing one variable may have upon another is to look for a dose-response relationship, in which a larger intervention in the treatment (the value in text form injected in the otherwise unchanged text sample) produces a larger response in the output (the softmax probability of a gendered pronoun).")
-    gr.Markdown("This dose-response plot requires a range of values along which we may see a spectrum of gender representation (or misrepresentation) in our datasets.")
-
     gr.Markdown("## This Demo")
     gr.Markdown("1) Click on one of the examples below (where we sweep through a spectrum of `places`, `date` and `subreddit` interest) to pre-populate the input fields.") 
     gr.Markdown("2) Check out the pre-populated fields as you scroll down to the ['Hit Submit...'] button!")
@@ -370,14 +366,14 @@ with demo:
         date_gen = gr.Button('Click for date example inputs')
 
         gr.Markdown(
-            "X-axis sorted by bottom 10 and top 10 [Global Gender Gap](https://www3.weforum.org/docs/WEF_GGGR_2021.pdf) ranked countries by World Economic Forum in 2021:")
+            "X-axis sorted by bottom 10 and top 10 [Global Gender Gap](https://www3.weforum.org/docs/WEF_GGGR_2021.pdf) ranked countries:")
         place_gen = gr.Button('Click for country example inputs')
 
         gr.Markdown(
-            "X-axis sorted in order of increasing self-identified female participation (see [bburky demo](http://bburky.com/subredditgenderratios/)): ")
+            "X-axis sorted in order of increasing self-identified female participation (see [bburky](http://bburky.com/subredditgenderratios/)): ")
         subreddit_gen = gr.Button('Click for Subreddit example inputs')
 
-        gr.Markdown("Date example with your own model loaded! (We recommend you try after seeing how others work. It can take a while to load new model.)")
+        gr.Markdown("Date example with your own model loaded! (If first time, try another example, it can take a while to load new model.)")
         your_gen = gr.Button('Click for your model example inputs')
 
     gr.Markdown("### Input fields")
@@ -391,8 +387,8 @@ with demo:
         )
 
 
-    gr.Markdown(
-        f"B) Pick a pre-loaded BERT-family model of interest on the right. C) Or select `{OWN_MODEL_NAME}`, then add the mame of any other Hugging Face model that supports the [fill-mask](https://huggingface.co/models?pipeline_tag=fill-mask) task on the right (note: this may take some time to load).")
+    gr.Markdown("B) Pick a pre-loaded BERT-family model of interest on the right.")
+    gr.Markdown(f"Or C) select `{OWN_MODEL_NAME}`, then add the mame of any other Hugging Face model that supports the [fill-mask](https://huggingface.co/models?pipeline_tag=fill-mask) task on the right (note: this may take some time to load).")
 
     with gr.Row():
         model_name = gr.Radio(
@@ -404,10 +400,9 @@ with demo:
             label="C) If you selected an 'add-your-own' model, put your models Hugging Face pipeline name here. We think it should work with any model that supports the fill-mask task.",
         )
 
-    gr.Markdown(
-        "We are able to test the pre-trained LLMs without any modification to the models, as the gender-pronoun prediction task is simply a special case of the masked language modeling (MLM) task, with which all these models were pre-trained. Rather than random masking, the gender-pronoun prediction task masks only non-gender-neutral terms (listed in prior [Space](https://huggingface.co/spaces/emilylearning/causing_gender_pronouns_two)).")
-    gr.Markdown("For the pre-trained LLMs the final prediction is a softmax over the entire tokenizer's vocabulary, from which we sum up the portion of the probability mass from the top five prediction words that are gendered terms. D) Pick if you want to the predictions normalied to these gendered terms only.")
-    gr.Markdown("E) Also tell the demo what special token you will use in your input text, that you would like replaced with the spectrum of values you listed above, and F) the degree of polynomial fit used for high-lighting possible dose response trend ")
+    gr.Markdown("D) Pick if you want to the predictions normalied to these gendered terms only.")
+    gr.Markdown("E) Also tell the demo what special token you will use in your input text, that you would like replaced with the spectrum of values you listed above.") 
+    gr.Markdown("And F) the degree of polynomial fit used for high-lighting possible dose response trend.")
 
 
     with gr.Row():
@@ -470,25 +465,51 @@ with demo:
         outputs=[sample_text, female_fig, male_fig, df])
 
 
+    gr.Markdown("### How does this work?")
+    gr.Markdown("We are able to test the pre-trained LLMs without any modification to the models, as the gender-pronoun prediction task is simply a special case of the masked language modeling (MLM) task, with which all these models were pre-trained. Rather than random masking, the gender-pronoun prediction task masks only non-gender-neutral terms (listed in prior [Space](https://huggingface.co/spaces/emilylearning/causing_gender_pronouns_two)).")
+    gr.Markdown("For the pre-trained LLMs the final prediction is a softmax over the entire tokenizer's vocabulary, from which we sum up the portion of the probability mass from the top five prediction words that are gendered terms (and normalize or not, based on selected preference above.")
+
+
+
     gr.Markdown("### What is Causing these Spurious Correlations?")
 
     gr.Markdown("Spurious correlations are often considered undesirable, as they do not match our intuition about the real-world domain from which we derive samples for inference-time prediction.")
-    gr.Markdown("Selection of samples into datasets is a zero-sum-game, with even our high quality datasets forced to trade off one for another, thus inducing selection bias into the learned associations of the model.")
+    gr.Markdown("Selection of samples into datasets can be a zero-sum-game, with even our high quality datasets forced to trade off one for another, thus inducing selection bias into the learned associations of the model.")
+   
+    gr.Markdown("### Dose-response Relationship")
+    gr.Markdown("One intuitive way to see the impact that changing one variable may have upon another is to look for a dose-response relationship, in which a larger intervention in the treatment (the value in text form injected in the otherwise unchanged text sample) produces a larger response in the output (the softmax probability of a gendered pronoun).")
+    gr.Markdown("This dose-response plot requires a range of values along which we may see a spectrum of gender representation (or misrepresentation) in our datasets.")
+
 
     gr.Markdown("### Data Generating Process")
-    gr.Markdown("To pick values below that are most likely to cause spurious correlations, it helps to make some assumptions about the training datasets' likely data generating process, and where selection bias may come in.")
+    gr.Markdown("To pick values below that are most likely to cause spurious correlations, it helps to make some assumptions about the training dataset's likely data generating process, and where selection bias may come in.")
+
+    gr.Markdown("A plausible data generating processes for Wiki-Bio and Reddit datasets is shown as a DAG below. The variables `W` : birth place, birth date or subreddit interest, and `G`: gender, are both independent variables that have no ancestral variables. However, `W` and `G` may have a role in causing one's access, `Z`. In the case of Wiki-Bio a functional form of `Z` may capture the general trend that access has become less gender-dependent over time, but not in every place. In the case of Reddit TLDR, `Z` may capture that despite some subreddits having gender-neutral topics, the specific style of moderation and community in the subreddit may reduce access to some genders.")
+
+    gr.Markdown("This DAG structure is prone to collider bias between `W` and `G` when conditioning on access, `Z`. In other words, although in real life *place*, *date*, and (subreddit) *interest* vs *gender* are unconditionally independent, when we condition on their common effect, *access*, they become unconditionally dependent.")
+    
+    gr.Markdown("The obvious solution to not condition on access is unavailable to us, as we are required to in order to represent the process of selection into the dataset. Thus, a statistical relationship between `W` and `G` can be induced by the dataset formation, leading to possible spurious correlations, as shown here.")
+
+
 
-    gr.Markdown("A plausible data generating processes for both Wikipedia and Reddit sourced data is shown as a DAG below. These DAGs are prone to collider bias when conditioning on `access`. In other words, although in real life `place`, `date`, (subreddit) `interest` and gender are all unconditionally independent, when we condition on their common effect, `access`, they become unconditionally dependent. Composing a dataset often requires the dataset maintainers to condition on `access`. Thus LLMs learn these dataset induced dependencies, appearing to us as spurious correlations.")
     gr.Markdown("""
+    <style>
+    img {
+        width: 30%;
+        max-width: 600px;
+    } 
+    </style>
     <center>
-    <img src="https://www.dropbox.com/s/f0numpllywdd271/combo_dag_block_party.png?raw=1" 
+    <img src="https://www.dropbox.com/s/4f07djirinl2qvy/show_g_crop.png?raw=1" 
         alt="DAG of possible data generating process for datasets used in training some of our LLMs.">
     </center>
     """)
 
-    gr.Markdown("There may be misassumptions in our DAG above, which you can explore above. Please contribute any corrections or new examples of interest!")
-    gr.Markdown("You may also be interested in applying this demo to your own model of interest. This demo _should_ work with any Hugging Face model that supports the [fill-mask](https://huggingface.co/models?pipeline_tag=fill-mask) task.")
-
+    gr.Markdown("### I Don't Buy It")
+    gr.Markdown("See something wrong above? Do you think we cherry picked our examples? Try your own, including your own x-axis. Think we cherry picked LLMs? Try the `add-your-own` model option. This demo _should_ work with any Hugging Face model that supports the [fill-mask](https://huggingface.co/models?pipeline_tag=fill-mask) task.")
+    gr.Markdown("Think our data generating process is wrong, or found an interesting spurious correlation you'd like to set as a default example? Use the community tab to discuss or pull request your fix.")
+    
 demo.launch(debug=True)
 
-# %%
+
+# %%