NAIL is an agent that plays text-based interactive fiction games.

Перейти к файлу

microsoft-github-policy-service[bot] 90d2381a35 Microsoft mandatory file		2022-08-30 09:36:00 +00:00
agent	Initial checkin.	2018-11-05 19:04:54 -08:00
.gitignore	Initial checkin.	2018-11-05 19:04:54 -08:00
LICENSE.pdf	Initial checkin.	2018-11-05 19:04:54 -08:00
README.md	Add link to NAIL paper.	2019-02-13 09:34:47 -08:00
SECURITY.md	Microsoft mandatory file	2022-08-30 09:36:00 +00:00
requirements.txt	Remove non-existent packages	2022-02-08 08:01:33 -08:00
run_nail_agent.py	Update code path.	2018-11-06 09:20:09 -08:00

README.md

NAIL agent

Navigate Acquire Interact Learn

NAIL is a general game-playing agent designed for parser-based interactive fiction games (Hausknecht et al. 2019). NAIL employs a simple heuristic: examine the current location to identify relevant objects, interact with the identified objects, navigate to a new location, and repeat. Though simple, this loop proves effective across a wide variety of games.

NAIL won first place in the 2018 Text-Based Adventure AI Competition (Atkinson et al. 2018), where it was evaluated on a set of twenty unknown parser-based IF games.

Requirements

Linux
Python 3

Installation

Install basic build tools.
- sudo apt-get update
- sudo apt-get install build-essential
- sudo apt-get install python3-dev
Install fastText
- pip3 install pybind11
- git clone https://github.com/facebookresearch/fastText.git
- cd fastText
- pip3 install .
- cd ..
Install Jericho
- pip3 install jericho
Clone this nail_agent repository to your Linux machine.
Download the NAIL agent's language model to the nail_agent/agent/affordance_extractors/language_model directory:
- wget http://download.microsoft.com/download/B/8/8/B88DDDC1-F316-412A-94B3-025788436054/nail_agent_lm.zip
unzip nail_agent_lm.zip
- The unzipped directory should contain 1028 files.
pip3 install numpy
pip3 install fuzzywuzzy
pip3 install spacy
python3 -m spacy download en
pip3 install python-Levenshtein

Usage

Obtain a z-machine game (like zork1.z5)
cd nail_agent
python3 run_nail_agent.py <path_to_game>

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.