Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amitkparekh committed Dec 5, 2023
1 parent 09c872c commit 9834725
Showing 1 changed file with 12 additions and 29 deletions.
41 changes: 12 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,48 +40,31 @@

TODO.

## Installing the repo

Like other repos in EMMA, we advocate for pyenv and Poetry for managing the project. To get setup with this repository, just run the following:

```bash
pyenv install
poetry env use $(pyenv which python)
poetry install
poetry shell
```

## How to do things with the CLI

There are more commands than mentioned here. For more details regarding _any command_, just add `--help`!

## How to update the service registry for SimBot

To change the models that are being used, update the file within `storage/registry/simbot/`

For example, to change the models being used in production, update `storage/registry/models/production.yml`. This change will propagate to all future actions.
## Installing the repo

## What if I need `sudo` with Docker?
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.

If you need `sudo` to run Docker, you need to also use the `-E` flag — i.e., use `sudo -E` to run the commands.
## How to find what things you can run

If it can't find the python path to the venv used for this installation, you can get the executable path from `which python` and then export it into a new variable.
There are more commands than mentioned here. For more details regarding _any command_, just add `--help`!

Assuming you've already installed and activated the virtualenv as above, you can run the following:
For example, you can start with

```bash
export LOCAL_PYTHON=$(which python)
sudo -E $LOCAL_PYTHON -m emma_experience_hub
poetry run python -m emma_experience_hub --help
```

## Running the staging environment
## 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, NLU, etc.). To do so we use Docker compose and it can be run as follows:

Assuming you have an EC2 instance already created, connect to the instance, and use tmux to create two panels. In the first panel, we need to
run all the background services required for EMMA (e.g., policy, NLU, etc.). To do so we use Docker
compose and it can be run as follows (for this you must use `sudo`):
> [!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"`
```bash
sudo -E env "PATH=$PATH" poetry run python -m emma_experience_hub simbot run-background-services --num-gpus 1
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:
Expand Down

0 comments on commit 9834725

Please sign in to comment.