Update README (#243)

* Update README Fixes #237 * Add citation block for v2 * Address review comments * Fix typo
iai-group · Feb 21, 2024 · bcdb7a1 · bcdb7a1
1 parent 96cafd6
commit bcdb7a1
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -6,42 +6,95 @@
 ![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/IKostric/4f783c1a3358dbd1e01d44f9656676a0/raw/coverage.MovieBot.main.json)
 ![Python version](https://img.shields.io/badge/python-3.9-blue)
 
-IAI MovieBot is a conversational recommender system for movies.  It follows a standard task-oriented dialogue system architecture, comprising of natural language understanding (NLU), dialogue manager (DM), and natural language generation (NLG) components.  The distinctive features of IAI MovieBot include a task-specific dialogue flow, a multi-modal chat interface, and an effective way to deal with dynamically changing user preferences.  While our current focus is limited to movies, the system aims to be a reusable development framework that can support users in accomplishing recommendation-related goals via multi-turn conversations.
+IAI MovieBot is a conversational recommender system for movies. It follows a standard task-oriented dialogue system architecture, comprising natural language understanding (NLU), dialogue manager (DM), and natural language generation (NLG) components. Additionally, it includes a user model and a recommendation engine. Some modules may use different models, which can be trained using the provided training utilities. It also comes with different deployment platforms (such as Telegram and Flask REST).
+The distinctive features of IAI MovieBot include a task-specific dialogue flow, a multi-modal chat interface, and an effective way to deal with dynamically changing user preferences. While our current focus is limited to movies, the system aims to be a reusable and extensible development framework that can support users in accomplishing recommendation-related goals via multi-turn conversations.
 
-## Demo
+The v1.0 version of IAI MovieBot has been presented as a demonstration paper at CIKM'20 [[PDF](https://arxiv.org/pdf/2009.03668.pdf)], while the v2.0 version is to appear at WSDM'24.
+<!-- TODO: Add link to arXiv for v2 -->
 
-IAI MovieBot can be tried on the Telegram channel [@iai_moviebot_bot](https://t.me/iai_moviebot_bot).
+## Versions
 
-## Installation and documentation
+Available versions of IAI MovieBot:
 
-The installation instructions and documentation can be found on [Read the Docs](https://iai-moviebot.readthedocs.io/).
+  * v2.0 (current version)
+  * [v1.1.0](https://github.com/iai-group/MovieBot/releases/tag/v1.1.0)
+  * [v1.0.1](https://github.com/iai-group/MovieBot/releases/tag/v1.0.1)
+  * [v1.0](https://github.com/iai-group/MovieBot/releases/tag/v1.0.0)
 
-## Run with Flask
+## Installation and usage
 
-Run the following command to start the IAI MovieBot with Flask:
+Installation and usage instructions are available in the [documentation](https://iai-moviebot.readthedocs.io/).
 
-```shell
-python -m moviebot.run -c config/moviebot_config_no_integration.yaml
-```
+## Components
+
+Below is the overview of IAI MovieBot 2.0 architecture. Blue components are inherited from IAI MovieBot 1.0 and the green ones are new additions. Training utilities are available for components marked with a star (*).
+
+![MovieBot v2 architecture](docs/source/_static/Blueprint_MovieBot_v2.png)
+
+<!-- TODO: Add link to related documentation pages -->
+
+  * Platform [[doc](https://iai-moviebot.readthedocs.io/en/latest/usage.html)]
+    - Terminal
+    - Telegram
+    - Flask REST
+    - Flask socket.io
+  * Natural Language Understanding (NLU)
+    - Rule-based
+    - JointBERT
+  * Dialogue management
+    - Dialogue policy
+      + Rule-based
+      + Deep Q-Network (DQN)
+      + Advantage Actor-Critic (A2C)
+    - Dialogue state tracking
+  * User model
+  * User model explainability
+  * Recommendation engine
+  * Natural Language Generation (NLG) [[doc](https://iai-moviebot.readthedocs.io/en/latest/architecture.html#natural-language-generation)]
+
+Training utilities:
+
+  * NLU training (JointBERT)
+  * Reinforcement learning training (DQN and A2C) using a user simulator [[doc](https://iai-moviebot.readthedocs.io/en/latest/reinforcement_learning.html)]
+
+## Demos
+
+IAI MovieBot v2.0 can be tried [here](https://iai-group.github.io/MovieBot/).
+
+<!-- TODO add screenshot -->
+
+IAI MovieBot v1.0 can be tried on the Telegram channel [@iai_moviebot_bot](https://t.me/iai_moviebot_bot).
+
+![MovieBot v1.0 Telegram demo](docs/source/_static/demo_MovieBot_v1_telegram.png)
 
 ## Contributions
 
 Contributions are welcome. Changes to IAI MovieBot should conform to the [IAI Python Style Guide](https://github.com/iai-group/guidelines/tree/main/python).
 
-## Publication
+## Citation
 
-The system is described in a CIKM'20 demo paper [[PDF](https://arxiv.org/pdf/2009.03668.pdf)].
+For the most recent version (v2.0) of IAI MovieBot, please cite:
 
+```bibtex
+@inproceedings{Bernard:2024:WSDM,
+    author = {Bernard, Nolwenn and Kostric, Ivica and Balog, Krisztian},
+    title = {IAI MovieBot 2.0: An Enhanced Research Platform with Trainable Neural Components and Transparent User Modeling},
+    year = {2024},
+    doi = {10.1145/3616855.3635699},
+    booktitle = {Proceedings of the 17th ACM International Conference on Web Search and Data Mining},
+    series = {WSDM '24}
+}
 ```
-@inproceedings{Habib:2020:IMC,
+
+For the v1.0 version of IAI MovieBot, please cite:
+
+```bibtex
+@inproceedings{Habib:2020:CIKM,
     author = {Habib, Javeria and Zhang, Shuo and Balog, Krisztian},
     title = {IAI {MovieBot}: {A} Conversational Movie Recommender System},
     year = {2020},
     booktitle = {Proceedings of the 29th ACM International Conference on Information and Knowledge Management},
-    publisher = {Association for Computing Machinery},
-    address = {New York, NY, USA},
     pages = {3405--3408},
-    url = {https://doi.org/10.1145/3340531.3417433},
     doi = {10.1145/3340531.3417433},
     series = {CIKM '20}
 }

diff --git a/docs/source/_static/Blueprint_MovieBot_v2.png b/docs/source/_static/Blueprint_MovieBot_v2.png
diff --git a/docs/source/_static/demo_MovieBot_v1_telegram.png b/docs/source/_static/demo_MovieBot_v1_telegram.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,7 +1,8 @@
 IAI MovieBot |release| documentation
 =====================================
 
-IAI MovieBot is a conversational recommender system for movies.  It follows a standard task-oriented dialogue system architecture, comprising of natural language understanding (NLU), dialogue manager (DM), and natural language generation (NLG) components.  The distinctive features of IAI MovieBot include a task-specific dialogue flow, a multi-modal chat interface, and an effective way to deal with dynamically changing user preferences.  While our current focus is limited to movies, the system aims to be a reusable development framework that can support users in accomplishing recommendation-related goals via multi-turn conversations.
+IAI MovieBot is a conversational recommender system for movies. It follows a standard task-oriented dialogue system architecture, comprising natural language understanding (NLU), dialogue manager (DM), and natural language generation (NLG) components. Additionally, it includes a user model and a recommendation engine. Some modules may use different models, which can be trained using the provided training utilities. It also comes with different deployment platforms (such as Telegram and Flask REST).
+The distinctive features of IAI MovieBot include a task-specific dialogue flow, a multi-modal chat interface, and an effective way to deal with dynamically changing user preferences. While our current focus is limited to movies, the system aims to be a reusable and extensible development framework that can support users in accomplishing recommendation-related goals via multi-turn conversations.
 
 .. toctree::
    :maxdepth: 1