Jericho

<p align="center"> <br> <img src="https://raw.githubusercontent.com/microsoft/jericho/master/docs/source/imgs/jericho.png" width="300"/> <br> <p> <p align="center"> <a href='https://ms-jericho.readthedocs.io/en/latest/?badge=latest'> <img src='https://readthedocs.org/projects/ms-jericho/badge/?version=latest' alt='Documentation Status' /> </a> <a href='https://github.com/microsoft/jericho/actions'> <img src='https://github.com/microsoft/jericho/actions/workflows/main.yml/badge.svg' alt='GitHub Actions Status' /> </a> <a href='https://badge.fury.io/py/jericho'> <img src='https://badge.fury.io/py/jericho.svg' alt='PyPI version' /> </a> <p> <p align="center"> A lightweight python-based interface connecting learning agents with interactive fiction games. <p> <br>

Requirements

Linux, Python 3.12+, Spacy, and basic build tools like gcc,make & curl.

Install

conda create -n jericho python=3
conda activate jericho

python -m pip install jericho
python -m spacy download en_core_web_sm

Documentation

• Quickstart
• Frotz Environment
• Object Tree
• Game Dictionary
• Template Action Generator
• Utilities
• Defines

Agents

• Reading Comprehension Deep Q-Network (RCDQN)
• Contextual Action Language Model (CALM)
• Q*BERT
• Knowledge Graph Advantage Actor Critic (KG-A2C)
• Template-DQN and DRRN

Citing Jericho

If Jericho is used in your research, please cite the following:

@article{hausknecht19,
  title={Interactive Fiction Games: A Colossal Adventure},
  author={Hausknecht, Matthew and Ammanabrolu, Prithviraj and C\^ot\'{e} Marc-Alexandre and Yuan Xingdi},
  journal={CoRR},
  year={2019},
  url={http://arxiv.org/abs/1909.05398},
  volume={abs/1909.05398}
}

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.