Support user-added models, return n-fit, doc improvement, rand output display text

app.py

@@ -1,3 +1,5 @@
+# %%
+from random import random
 import gradio as gr
 from transformers import pipeline
 from matplotlib.ticker import MaxNLocator
@@ -5,15 +7,17 @@ import pandas as pd
 import numpy as np
 import matplotlib.pyplot as plt
 
+
 MODEL_NAMES = ["bert-base-uncased",
                "distilbert-base-uncased", "xlm-roberta-base"]
+OWN_MODEL_NAME = 'add-your-own'
 
 DECIMAL_PLACES = 1
 EPS = 1e-5  # to avoid /0 errors
 
 # Example date conts
 DATE_SPLIT_KEY = "DATE"
-START_YEAR = 1800
+START_YEAR = 1801
 STOP_YEAR = 1999
 NUM_PTS = 20
 DATES = np.linspace(START_YEAR, STOP_YEAR, NUM_PTS).astype(int).tolist()
@@ -131,18 +135,14 @@ GENDERED_LIST = [
     ["actor", "actress"],
 ]
 
-
+# %%
 # Fire up the models
-# TODO: Make it so models can be added in the future
-models_paths = dict()
 models = dict()
 
+for bert_like in MODEL_NAMES:
+    models[bert_like] = pipeline("fill-mask", model=bert_like)
 
 # %%
-for bert_like in MODEL_NAMES:
-    models_paths[bert_like] = bert_like
-    models[bert_like] = pipeline(
-        "fill-mask", model=models_paths[bert_like])
 
 
 def get_gendered_token_ids():
@@ -171,6 +171,8 @@ def get_avg_prob_from_pipeline_outputs(mask_filled_text, gendered_token, num_pre
     return round(sum(pronoun_preds) / (EPS + num_preds) * 100, DECIMAL_PLACES)
 
 # %%
+
+
 def get_figure(df, gender, n_fit=1):
     df = df.set_index('x-axis')
     cols = df.columns
@@ -179,7 +181,7 @@ def get_figure(df, gender, n_fit=1):
     fig, ax = plt.subplots()
     # Trying small fig due to rendering issues on HF, not on VS Code
     fig.set_figheight(3)
-    fig.set_figwidth(8) 
+    fig.set_figwidth(9)
 
     # find stackoverflow reference
     p, C_p = np.polyfit(xs, ys, n_fit, cov=1)
@@ -197,30 +199,33 @@ def get_figure(df, gender, n_fit=1):
     ax.legend(list(df.columns))
 
     ax.axis('tight')
-
-    # fig.canvas.draw()
-
     ax.set_xlabel("Value injected into input text")
     ax.set_title(
         f"Probability of predicting {gender} pronouns.")
     ax.set_ylabel(f"Softmax prob for pronouns")
     ax.xaxis.set_major_locator(MaxNLocator(6))
-    ax.tick_params(axis='x', labelrotation=15)
+    ax.tick_params(axis='x', labelrotation=5)
     return fig
 
 
 # %%
 def predict_gender_pronouns(
-    model_type,
+    model_name,
+    own_model_name,
     indie_vars,
     split_key,
     normalizing,
+    n_fit,
     input_text,
 ):
     """Run inference on input_text for each model type, returning df and plots of percentage
     of gender pronouns predicted as female and male in each target text.
     """
-    model = models[model_type]
+    if model_name not in MODEL_NAMES:
+        model = pipeline("fill-mask", model=own_model_name)
+    else:
+        model = models[model_name]
+
     mask_token = model.tokenizer.mask_token
 
     indie_vars_list = indie_vars.split(',')
@@ -267,17 +272,19 @@ def predict_gender_pronouns(
     results_df['female_pronouns'] = female_pronoun_preds
     results_df['male_pronouns'] = male_pronoun_preds
     female_fig = get_figure(results_df.drop(
-        'male_pronouns', axis=1), 'female')
+        'male_pronouns', axis=1), 'female',  n_fit,)
     male_fig = get_figure(results_df.drop(
-        'female_pronouns', axis=1), 'male')
+        'female_pronouns', axis=1), 'male',  n_fit,)
+    display_text = f"{random.choice(indie_vars_list)}".join(text_segments)
 
     return (
-        target_text,
+        display_text,
         female_fig,
         male_fig,
         results_df,
     )
 
+
 # %%
 title = "Causing Gender Pronouns"
 description = """
@@ -287,74 +294,159 @@ description = """
 
 place_example = [
     MODEL_NAMES[0],
+    '',  
     ', '.join(PLACES),
     'PLACE',
     "False",
+    1,
     'Born in PLACE, she was a teacher.'
 ]
 
 date_example = [
     MODEL_NAMES[0],
+    '',  
     ', '.join(DATES),
     'DATE',
     "False",
+    3,
     'Born in DATE, she was a doctor.'
 ]
 
 
 subreddit_example = [
     MODEL_NAMES[2],
+    '',  
     ', '.join(SUBREDDITS),
     'SUBREDDIT',
     "False",
-    'I saw on r/SUBREDDIT that she is a hacker.'
+    1,
+    'I saw in r/SUBREDDIT that she is a hacker.'
+]
+
+own_model_example = [
+    OWN_MODEL_NAME,
+    'lordtt13/COVID-SciBERT',
+    ', '.join(DATES),
+    'DATE',
+    "False",
+    3,
+    'Ending her professorship in DATE, she was instrumental in developing the COVID vaccine.'
 ]
 
 
 def date_fn():
     return date_example
+
+
 def place_fn():
     return place_example
+
+
 def reddit_fn():
     return subreddit_example
 
 
+def your_fn():
+    return own_model_example
+
+
 # %%
 demo = gr.Blocks()
 with demo:
-    gr.Markdown("## Hunt for spurious correlations in our LLMs.")
+    gr.Markdown("## Spurious Correlation Evaluation for our 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("These spurious associations 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("### 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). Specifically, below are examples of sweeping through a spectrum of place, date and subreddit interest. We encourage you to try your own!")
+    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("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("""
+    <center>
+    <img src="https://www.dropbox.com/s/f0numpllywdd271/combo_dag_block_party.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 below.")
+    gr.Markdown("Or you may 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("### 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 Demo")
+    gr.Markdown("This type of plot requires a range of values along which we may see a spectrum of gender representation (or misrepresentation) in our datasets.")
+    gr.Markdown("Click on one of the examples below (where we sweep through a spectrum of `places`, `date` and `subreddit` interest) to get an idea of whats intended here. Then try your own!")
+
+    with gr.Row():
+        gr.Markdown("X-axis sorted by older to more recent dates:")
+        place_gen = gr.Button('Country example')
+
+        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:")
+        date_gen = gr.Button('Date example')
+
+        gr.Markdown(
+            "X-axis sorted in order of increasing self-identified female participation (see [bburky demo](http://bburky.com/subredditgenderratios/)): ")
+        subreddit_gen = gr.Button('Subreddit example')
+
+        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.)")
+        your_gen = gr.Button('Your model example')
+
     with gr.Row():
         x_axis = gr.Textbox(
             lines=5,
-            label="Pick a spectrum of values for text injection and x-axis",
+            label="Pick a spectrum of comma separated values for text injection and x-axis",
         )
+
+
+    gr.Markdown(
+        "Pick a pre-loaded BERT-family model of interest, or add another Hugging Face model that supports the [fill-mask](https://huggingface.co/models?pipeline_tag=fill-mask) task (this may take some time to load).")
+
     with gr.Row():
         model_name = gr.Radio(
-            MODEL_NAMES,
+            MODEL_NAMES + [OWN_MODEL_NAME],
             type="value",
-            label="Pick a BERT-like model.",
+            label="Model: Pick a BERT-like model.",
         )
-        place_holder = gr.Textbox(
-            label="Special token used in input text that will be replaced with the above spectrum of values.",
-            type="index",
+        own_model_name = gr.Textbox(
+            label="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. Pick if you want to the predictions normalied to these gendered terms only.")
+    gr.Markdown("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 the degree of polynomial fit used for high-lighting possible dose response trend ")
+
+
+    with gr.Row():
         to_normalize = gr.Dropdown(
             ["False", "True"],
-            label="Normalize?",
+            label="Normalize model's predictions to only the gendered ones?",
             type="index",
         )
+        place_holder = gr.Textbox(
+            label="Special token place-holder that used in input text that will be replaced with the above spectrum of values.",
+        )
+        n_fit = gr.Dropdown(
+            list(range(1, 5)),
+            label="Degree of polynomial fit for high-lighting possible dose response trend",
+            type="value",
+        )
+
+    gr.Markdown(
+        "Finally, add input text that includes at least one gendered pronouns and one place-holder token specified above.")
+
     with gr.Row():
         input_text = gr.Textbox(
-            lines=5,
-            label="Input Text: Sentence about a single person using some gendered pronouns to refer to them.",
+            lines=3,
+            label="Input Text: Sentence that includes gendered pronouns and your place-holder token specified above.",
         )
+
+    gr.Markdown("### Outputs!")
+    gr.Markdown("Scroll down and 'Hit Submit'!")
+
     with gr.Row():
         sample_text = gr.Textbox(
             type="auto", label="Output text: Sample of text fed to model")
@@ -367,32 +459,24 @@ with demo:
             overflow_row_behaviour="show_ends",
             label="Table of softmax probability for pronouns predictions",
         )
-    gr.Markdown("X-axis sorted by older to more recent dates:")
-    place_gen = gr.Button('Populate fields with a location example')
-
-    gr.Markdown("X-axis sorted by bottom 10 and top 10 Global Gender Gap ranked countries:")
-    date_gen = gr.Button('Populate fields with a date example')
-
-    gr.Markdown("X-axis sorted in order of increasing self-identified female participation (see [bburky demo](http://bburky.com/subredditgenderratios/)): ")
-    subreddit_gen = gr.Button('Populate fields with a subreddit example')
 
     with gr.Row():
 
-        date_gen.click(date_fn, inputs=[], outputs=[model_name,
-                       x_axis, place_holder, to_normalize, input_text])
+        date_gen.click(date_fn, inputs=[], outputs=[model_name, own_model_name,
+                       x_axis, place_holder, to_normalize,  n_fit, input_text])
         place_gen.click(place_fn, inputs=[], outputs=[
-                        model_name, x_axis, place_holder, to_normalize, input_text])
+                        model_name, own_model_name, x_axis, place_holder, to_normalize,  n_fit, input_text])
         subreddit_gen.click(reddit_fn, inputs=[], outputs=[
-                            model_name, x_axis, place_holder, to_normalize, input_text])
+                            model_name, own_model_name, x_axis, place_holder, to_normalize,  n_fit, input_text])
+        your_gen.click(your_fn, inputs=[], outputs=[
+            model_name, own_model_name, x_axis, place_holder, to_normalize,  n_fit, input_text])
+
     with gr.Row():
         btn = gr.Button("Hit submit")
         btn.click(
             predict_gender_pronouns,
-            inputs=[model_name, x_axis, place_holder,
-                    to_normalize, input_text],
+            inputs=[model_name, own_model_name, x_axis, place_holder,
+                    to_normalize, n_fit, input_text],
             outputs=[sample_text, female_fig, male_fig, df])
 
-demo.launch(debug=True)
-
-
-# %%
+demo.launch(debug=True)