Skip to content

Added the side channel for the Engine Configuration.#2958

Merged
vincentpierre merged 3 commits into
develop-side-channelfrom
develop-side-channel-engine-config
Nov 25, 2019
Merged

Added the side channel for the Engine Configuration.#2958
vincentpierre merged 3 commits into
develop-side-channelfrom
develop-side-channel-engine-config

Conversation

@vincentpierre
Copy link
Copy Markdown
Contributor

@vincentpierre vincentpierre commented Nov 23, 2019

Note that this change does not require modifying a lot of files :

  • Adding a sender in Python
  • Adding a receiver in C#
  • subscribe the receiver to the communicator (here is a one liner in the Academy)
  • Add the side channel to the Python UnityEnvironment (not represented here)

Adding the side channel to the environment would look like such :

from mlagents.envs.environment import UnityEnvironment
from mlagents.envs.side_channel.raw_bytes_channel import RawBytesChannel
from mlagents.envs.side_channel.engine_configuration_channel import EngineConfigurationChannel

channel0 = RawBytesChannel()
channel1 = EngineConfigurationChannel()

env = UnityEnvironment(base_port = 5004, side_channels = [channel0, channel1])

@vincentpierre
Added the side channel for the Engine Configuration.
ec567a2 
Note that this change does not require modifying a lot of files :
 - Adding a sender in Python
 - Adding a receiver in C#
 - subscribe the receiver to the communicator (here is a one liner in the Academy)
 - Add the side channel to the Python UnityEnvironment (not represented here)

Adding the side channel to the environment would look like such :

```python
from mlagents.envs.environment import UnityEnvironment
from mlagents.envs.side_channel.raw_bytes_channel import RawBytesChannel
from mlagents.envs.side_channel.engine_configuration_channel import EngineConfigurationChannel

channel0 = RawBytesChannel()
channel1 = EngineConfigurationChannel()

env = UnityEnvironment(base_port = 5004, side_channels = [channel0, channel1])
```
@vincentpierre vincentpierre self-assigned this Nov 23, 2019
@vincentpierre vincentpierre requested review from ervteng and removed request for harperj and surfnerd November 25, 2019 17:50
chriselion
chriselion reviewed Nov 25, 2019
View reviewed changes
Comment thread ml-agents-envs/mlagents/envs/side_channel/engine_configuration_channel.py Outdated
"""

def __init__(self):
self.received_messages = []
Copy link
Copy Markdown
Contributor

@chriselion chriselion Nov 25, 2019

Choose a reason for hiding this comment

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

Don't need self.received_messages?

Copy link
Copy Markdown
Contributor Author

@vincentpierre vincentpierre Nov 25, 2019

Choose a reason for hiding this comment

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

right

chriselion
chriselion approved these changes Nov 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@chriselion chriselion left a comment

Choose a reason for hiding this comment

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

Looks good. I think if this is only going to be set once, we don't need any more structure around the args for set_configuration() (I thought initially we might need a NamedTuple)

@vincentpierre vincentpierre merged commit b98cf97 into develop-side-channel Nov 25, 2019
@delete-merged-branch delete-merged-branch Bot deleted the develop-side-channel-engine-config branch November 25, 2019 21:11
vincentpierre added a commit that referenced this pull request Nov 26, 2019
@vincentpierre
Develop side channel (#2956)
bc1acaf 
* [WIP] Side Channel initial layout

* Working prototype for raw bytes

* fixing format mistake

* Added some errors and some unit tests in C#

* Added the side channel for the Engine Configuration. (#2958)

* Added the side channel for the Engine Configuration.

Note that this change does not require modifying a lot of files :
 - Adding a sender in Python
 - Adding a receiver in C#
 - subscribe the receiver to the communicator (here is a one liner in the Academy)
 - Add the side channel to the Python UnityEnvironment (not represented here)

Adding the side channel to the environment would look like such :

```python
from mlagents.envs.environment import UnityEnvironment
from mlagents.envs.side_channel.raw_bytes_channel import RawBytesChannel
from mlagents.envs.side_channel.engine_configuration_channel import EngineConfigurationChannel

channel0 = RawBytesChannel()
channel1 = EngineConfigurationChannel()

env = UnityEnvironment(base_port = 5004, side_channels = [channel0, channel1])
```

* renamings

* addressing comments

* Logging a message when an unknown side channel number has been received by Unity

* Addressing comments

* renamings

* renamings

* Adding FloatProperties to the side channels (#2968)

* renaming m_SideChannelsDict to m_SideChannel

* renaming and some comments

* renaming and adding a GetAndClearReceivedMessages() in the RawBytesSideChannel

* micro-optimization

* more errors and some nit

* addressing comments

* Using little-endian format in Python

* adding some comments

* Code comments

* some changes and added the unit tests on both Python and C#

* removing default default in get default

* Update UnitySDK/Assets/ML-Agents/Scripts/SideChannel/SideChannel.cs

Co-Authored-By: Chris Elion <chris.elion@unity3d.com>

* Update ml-agents-envs/mlagents/envs/side_channel/raw_bytes_channel.py

Co-Authored-By: Chris Elion <chris.elion@unity3d.com>

* addressing comments

* fixing tests
vincentpierre added a commit that referenced this pull request Dec 4, 2019
@vincentpierre
Develop side channels: migrate reset parameters (#2990)
fa7d381 
* [WIP] Side Channel initial layout

* Working prototype for raw bytes

* fixing format mistake

* Added some errors and some unit tests in C#

* Added the side channel for the Engine Configuration. (#2958)

* Added the side channel for the Engine Configuration.

Note that this change does not require modifying a lot of files :
 - Adding a sender in Python
 - Adding a receiver in C#
 - subscribe the receiver to the communicator (here is a one liner in the Academy)
 - Add the side channel to the Python UnityEnvironment (not represented here)

Adding the side channel to the environment would look like such :

```python
from mlagents.envs.environment import UnityEnvironment
from mlagents.envs.side_channel.raw_bytes_channel import RawBytesChannel
from mlagents.envs.side_channel.engine_configuration_channel import EngineConfigurationChannel

channel0 = RawBytesChannel()
channel1 = EngineConfigurationChannel()

env = UnityEnvironment(base_port = 5004, side_channels = [channel0, channel1])
```

* renamings

* addressing comments

* Logging a message when an unknown side channel number has been received by Unity

* Addressing comments

* renamings

* renamings

* Adding FloatProperties to the side channels (#2968)

* renaming m_SideChannelsDict to m_SideChannel

* renaming and some comments

* renaming and adding a GetAndClearReceivedMessages() in the RawBytesSideChannel

* micro-optimization

* more errors and some nit

* addressing comments

* Using little-endian format in Python

* adding some comments

* Code comments

* some changes and added the unit tests on both Python and C#

* removing default default in get default

* Update UnitySDK/Assets/ML-Agents/Scripts/SideChannel/SideChannel.cs

Co-Authored-By: Chris Elion <chris.elion@unity3d.com>

* Update ml-agents-envs/mlagents/envs/side_channel/raw_bytes_channel.py

Co-Authored-By: Chris Elion <chris.elion@unity3d.com>

* addressing comments

* fixing tests

* removing the arguments to reset and the property reset_parameters on the UnityEnvironment

* curriculum works but removed the check for reset parameters in the scene

* processing side channels before the reset command

* Removing engine configuration from C#

* Engine configuration removed

* fixing the tests

* Update ml-agents-envs/mlagents/envs/subprocess_env_manager.py

Co-Authored-By: Chris Elion <chris.elion@unity3d.com>

* Removing register callbacks with empty calls in FloarProperties

* Clamp instead of min max

* removing the brain names from the environment.py print

* renaming reset_parameters to get
properties

* made a default engine config

* bug fix

* Empty commit

* Docs changes for the Side Channels feature (#3011)

* Docs changes for the Side Channels feature

* replace deprecated with removed on the CustomResetPratmeters`

* Update docs/Python-API.md

Co-Authored-By: Chris Elion <chris.elion@unity3d.com>

* Update docs/Training-Generalized-Reinforcement-Learning-Agents.md

Co-Authored-By: Chris Elion <chris.elion@unity3d.com>

* Removing the console outputs in the docs

* Update docs/Training-ML-Agents.md

Co-Authored-By: Chris Elion <chris.elion@unity3d.com>

* replace does not work with ignored

* adding a note on side channels

* adding some steps to migrate

* addressing comments

* adding more docs to the LL-API

* added a blob on how to access the properties in C#

* adding space between ResetParameters

* fix typo

* bug fixes

* addressing comments
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators May 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@ervteng ervteng Awaiting requested review from ervteng

1 more reviewer

@chriselion chriselion chriselion approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@vincentpierre vincentpierre

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@vincentpierre @chriselion