Skip to content

update FAQ to include disabling graphics #4159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2020
Merged

update FAQ to include disabling graphics #4159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c2eb00
update FAQ and exception message
Jun 24, 2020
b8f3c8a
remove colab link
Jun 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ There may be a number of possible causes:
Unity Environment to figure what error happened.
- _Cause_: You have assigned `HTTP_PROXY` and `HTTPS_PROXY` values in your
environment variables. _Solution_: Remove these values and try again.
- _Cause_: You are running in a headless environment (e.g. remotely connected
to a server). _Solution_: Pass `--no-graphics` to `mlagents-learn`, or
`no_graphics=True` to `RemoteRegistryEntry.make()` or the `UnityEnvironment`
initializer. If you need graphics for visual observations, you will need to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
initializer. If you need graphics for visual observations, you will need to
constructor. If you need graphics for visual observations, you will need to

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, it's not a constructor. https://stackoverflow.com/questions/28791639/python-initializer-vs-constructor

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mind = blown

set up `xvfb` (or equivalent).

## Communication port {} still in use

Expand Down
2 changes: 1 addition & 1 deletion ml-agents-envs/mlagents_envs/rpc_communicator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ def poll_for_timeout(self):
raise UnityTimeOutException(
"The Unity environment took too long to respond. Make sure that :\n"
"\t The environment does not need user interaction to launch\n"
"\t The Agents are linked to the appropriate Brains\n"
'\t The Agents\' Behavior Parameters > Behavior Type is set to "Default"\n'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

black changed this to single quotes.

"\t The environment and the Python interface have compatible versions."
)

Expand Down