Skip to content

Commit d4c4b3a

Browse files
author
Chris Elion
authored
update FAQ to include disabling graphics (#4159)
* update FAQ and exception message * remove colab link
1 parent 07ea62a commit d4c4b3a

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/FAQ.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,11 @@ There may be a number of possible causes:
8989
Unity Environment to figure what error happened.
9090
- _Cause_: You have assigned `HTTP_PROXY` and `HTTPS_PROXY` values in your
9191
environment variables. _Solution_: Remove these values and try again.
92+
- _Cause_: You are running in a headless environment (e.g. remotely connected
93+
to a server). _Solution_: Pass `--no-graphics` to `mlagents-learn`, or
94+
`no_graphics=True` to `RemoteRegistryEntry.make()` or the `UnityEnvironment`
95+
initializer. If you need graphics for visual observations, you will need to
96+
set up `xvfb` (or equivalent).
9297

9398
## Communication port {} still in use
9499

ml-agents-envs/mlagents_envs/rpc_communicator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def poll_for_timeout(self):
9696
raise UnityTimeOutException(
9797
"The Unity environment took too long to respond. Make sure that :\n"
9898
"\t The environment does not need user interaction to launch\n"
99-
"\t The Agents are linked to the appropriate Brains\n"
99+
'\t The Agents\' Behavior Parameters > Behavior Type is set to "Default"\n'
100100
"\t The environment and the Python interface have compatible versions."
101101
)
102102

0 commit comments

Comments
 (0)