Merge pull request #83 from AnFreTh/main

Release v0.1.5

README.md

@@ -17,7 +17,7 @@
 
 
 # STREAM
-We present STREAM, a Simplified Topic Retrieval, Exploration, and Analysis Module for user-friendly topic modelling and especially subsequent interactive topic visualization and analysis. 
+We present STREAM, a Simplified Topic Retrieval, Exploration, and Analysis Module for user-friendly topic modelling and especially subsequent interactive topic visualization and analysis. Our paper can be found [here](https://aclanthology.org/2024.acl-short.41.pdf).
 
 # Table of Contents
 - [STREAM](#stream)
@@ -46,7 +46,7 @@ We present STREAM, a Simplified Topic Retrieval, Exploration, and Analysis Modul
       - [Validation Criteria](#validation-criteria)
       - [Submitting Your Contribution](#submitting-your-contribution)
 - [Citation](#citation)
-    - [Paper 1 TBD](#paper-1-tbd)
+    - [STREAM](#stream-1)
     - [Metrics and CEDC](#metrics-and-cedc)
     - [TNTM](#tntm)
     - [DCTE](#dcte)
@@ -80,6 +80,9 @@ Make additionally sure to download the necessary [nltk](https://www.nltk.org/) r
 
 ```python
 import nltk
+nltk.download('stopwords')
+nltk.download('punkt')
+nltk.download('wordnet')
 nltk.download('averaged_perceptron_tagger')
 ```
 
@@ -604,18 +607,16 @@ If you want to include a new model where these guidelines are not approriate ple
 
 If you use this project in your research, please consider citing:
 
-### Paper 1 TBD
+### STREAM
 
 ```bibtex
-@article{your_paper_key1,
-  title={Your Paper Title},
-  author={Your Name and Co-Author's Name},
-  journal={Journal/Conference Name},
-  year={Year},
-  volume={Volume},
-  number={Number},
-  pages={Pages},
-  doi={link_to_doi}
+@inproceedings{thielmann-etal-2024-stream,
+    title = {STREAM: Simplified Topic Retrieval, Exploration, and Analysis Module},
+    author = {Thielmann, Anton  and Reuter, Arik  and Weisser, Christoph  and Kant, Gillian  and Kumar, Manish  and S{\"a}fken, Benjamin},
+    booktitle = {Proceedings of the 62nd Annual Meeting of the Association for Computational Linguistics (Volume 2: Short Papers)},
+    year = {2024},
+    publisher = {Association for Computational Linguistics},
+    pages = {435--444},
 }
 ```
 

docs/installation.md

@@ -19,9 +19,13 @@ pip install stream_topic
 
 ### Install the required dependencies:
 
-Make sure you have installed the required dependencies before installing `stream_topic`. You can install the required dependencies using the following command:
+Make sure you have installed the required dependencies before running any models from `stream_topic`. You can install the required dependencies using the following command:
 
 ```bash
 import nltk
+
+nltk.download('punkt')
+nltk.download('wordnet')
+nltk.download('stopwords')
 nltk.download('averaged_perceptron_tagger')
 ```

docs/landingpage.md

@@ -1,5 +1,5 @@
 # STREAM
-We present STREAM, a Simplified Topic Retrieval, Exploration, and Analysis Module for user-friendly topic modelling and especially subsequent interactive topic visualization and analysis. 
+We present STREAM, a Simplified Topic Retrieval, Exploration, and Analysis Module for user-friendly topic modelling and especially subsequent interactive topic visualization and analysis. Our paper can be found [here](https://aclanthology.org/2024.acl-short.41.pdf).
 
 For better topic analysis, we implement multiple intruder-word based topic evaluation metrics. Additionally, we publicize multiple new datasets that can extend the so far very limited number of publicly available benchmark datasets in topic modeling. We integrate downstream interpretable analysis modules to enable users to easily analyse the created topics in downstream tasks together with additional tabular information.
 
@@ -28,6 +28,9 @@ Make additionally sure to download the necessary [nltk](https://www.nltk.org/) r
 
 ```python
 import nltk
+nltk.download('stopwords')
+nltk.download('punkt')
+nltk.download('wordnet')
 nltk.download('averaged_perceptron_tagger')
 ```
 
@@ -416,15 +419,13 @@ If you use this project in your research, please consider citing:
 ### Paper 1 TBD
 
 ```bibtex
-@article{your_paper_key1,
-  title={Your Paper Title},
-  author={Your Name and Co-Author's Name},
-  journal={Journal/Conference Name},
-  year={Year},
-  volume={Volume},
-  number={Number},
-  pages={Pages},
-  doi={link_to_doi}
+@inproceedings{thielmann-etal-2024-stream,
+    title = {STREAM: Simplified Topic Retrieval, Exploration, and Analysis Module},
+    author = {Thielmann, Anton  and Reuter, Arik  and Weisser, Christoph  and Kant, Gillian  and Kumar, Manish  and S{\"a}fken, Benjamin},
+    booktitle = {Proceedings of the 62nd Annual Meeting of the Association for Computational Linguistics (Volume 2: Short Papers)},
+    year = {2024},
+    publisher = {Association for Computational Linguistics},
+    pages = {435--444},
 }
 ```