up

README.md

@@ -1,3 +1,75 @@
-# IRENE
+<div align="center">
+<h1> Neural Reasoning about Agents' Goals, Preferences, and Actions </h1>
 
-Official code of "Neural Reasoning About Agents' Goals, Preferences, and Actions"
+**[Matteo Bortoletto][1], &nbsp; [Lei Shi][2], &nbsp; [Andreas Bulling][3]** <br> <br>
+**AAAI'24, Vancouver, CA** <br>
+**[[Paper][4]]**
+
+</div>
+
+# Citation
+If you find our code useful or use it in your own projects, please cite our paper:
+
+```bibtex
+@inproceedings{bortoletto2024neural,
+  author = {Bortoletto, Matteo and Lei, Shi and Bulling, Andreas},
+  title = {{Neural Reasoning about Agents' Goals, Preferences, and Actions}},
+  booktitle = {Proc. 38th AAAI Conference on Artificial Intelligence (AAAI)},
+  year = {2024},
+}
+```
+
+# Setup
+
+This code is based on the [original implementation][5] of the BIB benchmark. 
+
+## Using `virtualenv`
+```
+python -m virtualenv /path/to/env
+source /path/to/env/bin/activate
+pip install -r requirements.txt
+```
+
+## Using `conda`
+```
+conda create --name <env_name> python=3.8.10 pip=20.0.2 cudatoolkit=10.2.89
+conda activate <env_name>
+pip install -r requirements_conda.txt
+pip install dgl-cu102 dglgo -f https://data.dgl.ai/wheels/repo.html
+```
+
+
+# Running the code 
+
+## Activate the environment
+Run `source bibdgl/bin/activate`.
+
+## Index data
+This will create the json files with all the indexed frames for each episode in each video.
+```
+python utils/index_data.py
+```
+You need to manually set `mode` in the dataset class (in main). 
+
+## Generate graphs 
+This will generate the graphs from the videos:
+```
+python /utils/build_graphs.py --mode MODE --cpus NUM_CPUS
+```
+`MODE` can be `train`, `val` or `test`. NOTE: check `utils/build_graphs.py` to make sure you're loading the correct dataset to generate the graphs you want. 
+
+## Training
+You can use the `gtbc.sh`.
+
+## Testing 
+Use `run_test_tom.sh`. 
+
+# Hardware setup
+All models are trained on an NVIDIA Tesla V100-SXM2-32GB GPU. 
+
+
+[1]: https://mattbortoletto.github.io/
+[2]: https://perceptualui.org/people/shi/
+[3]: https://perceptualui.org/people/bulling/
+[4]: https://perceptualui.org/publications/bortoletto24_aaai.pdf
+[5]: https://github.com/kanishkg/bib-baselines