butterswords commited on
Commit
26d7ce6
β€’
1 Parent(s): d1a4408

Update README.md

Browse files

Adding in some additional known limitations.

Files changed (1) hide show
  1. README.md +4 -3
README.md CHANGED
@@ -1,6 +1,6 @@
1
  ---
2
  title: NLC Explorer
3
- emoji: πŸ’©
4
  colorFrom: gray
5
  colorTo: purple
6
  sdk: streamlit
@@ -14,12 +14,13 @@ license: mit
14
  ### A Natural Language Counterfactual Generator for Exploring Bias in Sentiment Analysis Algorithms
15
 
16
  ##### Overview
17
- This project is an extension of [Interactive Model Cards](https://github.com/amcrisan/interactive-model-cards). It focuses on providing a person more ways to explore the bias of a model through the generation of alternatives (technically [counterfactuals](https://plato.stanford.edu/entries/counterfactuals/#WhatCoun)). We believe the use of alternatives people can better understand the limitations of a model and develop productive skepticism around its usage and trustworthiness.
18
 
19
  ##### Known Limitations
20
  * Words not in the spaCy vocab for `en_core_web_lg` won't have vectors and so won't have the ability to create similarity scores.
21
  * WordNet provides many limitations due to its age and lack of funding for ongoing maintenance. It provides access to a large variety of the English language but certain words simply do not exist.
22
- * There are currently only 2 lists (Countries and Professions). We would like to find community curated lists for: Race, Sexual Orientation and Gender Identity (SOGI), Religion, age, and protected status.
 
23
 
24
 
25
  ##### Key Dependencies and Packages
 
1
  ---
2
  title: NLC Explorer
3
+ emoji: 🧭 πŸ” ⁉️
4
  colorFrom: gray
5
  colorTo: purple
6
  sdk: streamlit
 
14
  ### A Natural Language Counterfactual Generator for Exploring Bias in Sentiment Analysis Algorithms
15
 
16
  ##### Overview
17
+ This project is a digression from the project on [Interactive Model Cards](https://github.com/amcrisan/interactive-model-cards). It focuses on providing a person more ways to explore a model's outputs through the generation of alternatives (technically [counterfactuals](https://plato.stanford.edu/entries/counterfactuals/#WhatCoun)). We believe the use of multiple alternatives may allow people to better understand the limitations of a model and develop a sense of its trustworthiness and bias.
18
 
19
  ##### Known Limitations
20
  * Words not in the spaCy vocab for `en_core_web_lg` won't have vectors and so won't have the ability to create similarity scores.
21
  * WordNet provides many limitations due to its age and lack of funding for ongoing maintenance. It provides access to a large variety of the English language but certain words simply do not exist.
22
+ * There are currently only 2 lists (Countries and Professions). We would like to find community curated lists for: Race, Sexual Orientation and Gender Identity (SOGI), Religion, age, and other protected statuses.
23
+ * We do not have a custom pipeline for Named Entity Recognition (NER), or a matcher, to identify complex terms (ex. "two spirit", "male to female", "Asian American", etc.) and so these will not be fully available for interrogation.
24
 
25
 
26
  ##### Key Dependencies and Packages