diff --git a/README.md b/README.md index b535821..4bf275b 100644 --- a/README.md +++ b/README.md @@ -80,14 +80,14 @@ We recommend running the VM with KVM support. To check if your hosting platform egrep -c '(vmx|svm)' /proc/cpuinfo ``` on Linux. If the return value is greater than zero, the processor should be able to support KVM. -> **Note**: macOS hosts generally do not support KVM. +> **Note**: macOS hosts generally do not support KVM. You are advised to use VMware if you would like to run OSWorld on macOS. #### Install Docker If your hosting platform supports a graphical user interface (GUI), you may refer to [Install Docker Desktop on Linux](https://docs.docker.com/desktop/install/linux/) or [Install Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/) based on your OS. Otherwise, you may [Install Docker Engine](https://docs.docker.com/engine/install/). #### Running Experiments Add the following arguments when initializing `DesktopEnv`: -- `provider`: `docker` +- `provider_name`: `docker` - `os_type`: `Ubuntu` or `Windows`, depending on the OS of the VM ### Others diff --git a/desktop_env/providers/docker/DOCKER_GUIDELINE.md b/desktop_env/providers/docker/DOCKER_GUIDELINE.md index eb0cbde..b13752b 100644 --- a/desktop_env/providers/docker/DOCKER_GUIDELINE.md +++ b/desktop_env/providers/docker/DOCKER_GUIDELINE.md @@ -14,7 +14,7 @@ egrep -c '(vmx|svm)' /proc/cpuinfo on Linux. If the return value is greater than zero, the processor should be able to support KVM. -> **Note**: macOS hosts generally do not support KVM. +> **Note**: macOS hosts generally do not support KVM. You are advised to use VMware if you would like to run OSWorld on macOS. ## Install Docker @@ -23,7 +23,7 @@ If your hosting platform supports graphical user interface (GUI), you may refer ## Running Experiments Add the following arguments when initializing `DesktopEnv`: -- `provider`: `docker` +- `provider_name`: `docker` - `os_type`: `Ubuntu` or `Windows`, depending on the OS of the VM Please allow for some time to download the virtual machine snapshot on your first run.