Merge branch 'main' of https://github.com/nfelnlp/thermometer into main

DFKI-NLP · Sep 1, 2021 · 1f17e60 · 1f17e60
2 parents cc3bcd9 + 51f079b
commit 1f17e60
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/src/thermostat/streamlit/README.md b/src/thermostat/streamlit/README.md
@@ -0,0 +1,12 @@
+# Exploring Thermostat with Streamlit
+
+This is based on an implementation by [Hugging Face](https://github.com/huggingface/datasets-viewer/tree/master) which they are using for their browser interface called [datasets viewer](https://huggingface.co/datasets/viewer/).
+
+1. Setup a virtual environment and install our [PyPI package](https://pypi.org/project/thermostat-datasets/) `thermostat-datasets`.  
+2. Run `streamlit run run.py` from this directory which opens a new tab in your browser.
+3. At the start, it will automatically download the `ag_news-albert-lgxa` configuration to your cache directory. This can take a while depending on your connection.
+4. You can now freely explore all the Thermostat configurations using the sidebar dropdown menu.
+
+![streamlit-menu](streamlit-menu.png)
+
+The checkbox "Show Attribution Scores" additionally gives you the option to add the feature attributions (rounded to three digits) as labels to each token.
diff --git a/src/thermostat/streamlit/streamlit-menu.png b/src/thermostat/streamlit/streamlit-menu.png