README.md

EMMA: Experience Hub

Important

If you have questions or find bugs or anything, you can contact us in our organisation's discussion.

Installing the repo

Like other repos in EMMA, we advocate for pyenv and Poetry for managing the project. To get setup with this repository, make sure you are running Python 3.9 and then just use Poetry to install and get going.

How to find what things you can run

There are more commands than mentioned here. For more details regarding any command, just add --help!

For example, you can start with

poetry run python -m emma_experience_hub --help

Running things

Use tmux to create two panels. In the first panel, we need to run all the background services required for EMMA (e.g., policy, contextual routing (CR), etc.). To do so we use Docker compose and it can be run as follows:

Tip

If you need sudo to run Docker commands on your machine, you can prefix command that runs Docker with sudo -E env "PATH=$PATH"

poetry run python -m emma_experience_hub simbot run-background-services --num-gpus 1

Then, in the second tab you can run the experience hub:

python -m emma_experience_hub simbot run-controller-api --auxiliary-metadata-dir ../staging_auxiliary_metadata --auxiliary-metadata-cache-dir ../cache/auxiliary_metadata --extracted-features-cache-dir ../cache/features

Make sure that all the services are up and running. Happy debugging!