Skip to content

RELEASE_NOTES.md

Latest commit

 

History

History
145 lines (104 loc) · 4.74 KB

RELEASE_NOTES.md

File metadata and controls

145 lines (104 loc) · 4.74 KB

Release Notes

[1.1.7]

  • Support for NumPy 2.x.
  • Various bug fixes.

[1.1.6]

  • New AsyncConnection class that allows users to make asynchronous requests via asyncio.
  • Add optional metadata argument to create_secure_channel_and_connect.
  • Expose error status details in DmEnvRpcError exception.
  • Improvements and fixes related to type hints, in particular hints relating to NumPy.
  • Add utility functions for packing/unpacking custom request/responses.
  • Remove support for Python 3.7, now that it has reached EOL.

[1.1.5]

  • Add optional strict argument to dictionary flattening.
  • Relax flattening of create/join world settings, so that users can pass already flattened settings.

[1.1.4]

  • Support for nested create/join world settings in dm_env_adaptor helper functions.
  • Support scalar min/max bounds for array actions in compliance tests.
  • Allow DmEnvAdaptor to be closable multiple times.
  • Cleaned up various type hints, specifically removing deprecated NumPy type aliases.
  • Bug fixes.

[1.1.3]

  • Pass all additional keyword arguments through to DmEnvAdaptor when using create/join helper functions.
  • Bug fixes and cleanup.

[1.1.2]

  • Fixed Catch human agent example, raised in this GitHub issue.
  • Fixed bug when attempting to pack an empty array as a particular dtype.
  • Minor cleanup.

[1.1.1]

  • Removed support for Python 3.6
  • Updated compliance tests to support wider range of environments.
  • Fixed bug with packing large np.uint64 scalars.
  • Various PyType fixes.

[1.1.0]

WARNING: This release removes support for some previously deprecated fields. This may mean that scalar bounds for older environments are no longer readable. Users are advised to either revert to an older version, or re-build their environments to use the newer, multi-dimensional TensorSpec.Value fields.

  • Removed scalar TensorSpec.Value fields, which were marked as deprecated in v1.0.1. These have been superseded by array variants, which can be used for scalar bounds by creating a single element array.
  • Removed deprecated Property request/responses. These are now provided through the optional Property extension.
  • Refactored Connection to expose message packing utilities.

[1.0.6]

  • tensor_spec.bounds() no longer broadcasts scalar bounds.
  • Fixed bug where reward and discount were inadvertently included in the observations when using dm_env_adaptor, without explicitly requesting these as observations.

[1.0.5]

  • Better support for string specs in dm_env_adaptor.
  • Improved Python type annotations.
  • Check that the server has returned the correct response in dm_env_rpc.Connection class.
  • Added create_world helper function to dm_env_adaptor.

[1.0.4]

  • Better support for variable sized tensors.
  • Support for packing/unpacking tensors that use Any protobuf messages.
  • Bug fixes.

[1.0.3]

Added

  • Support for property descriptions.
  • New utility functions for creating a Connection instance from a server address.
  • DmEnvAdaptor helper functions for creating and joining worlds.
  • Additional compliance tests for resetting.
  • Support for optional DmEnvAdaptor extensions.

Changed

  • Removed portpicker dependency, instead relying on gRPC port picking functionality.
  • Changed property extension API to be more amenable to being used as an extension object for DmEnvAdaptor.

[1.0.2]

  • Explicitly support nested tensors by the use of a period character in the TensorSpec name to indicate a level of nesting. Updated dm_env adaptor to flatten/unflattten actions and observations.
  • Increased minimum Python version to 3.6.
  • Moved property request/responses to its own extension. This supersedes the previous property requests, which have been marked as deprecated. These requests will be removed in a future version of dm_env_rpc.
  • Speed improvements for packing and unpacking byte arrays in Python.

[1.0.1]

Added

  • Support for per-element min/max values. This supersedes the existing scalar fields, which have been marked as deprecated. These fields will be be removed in a future version of dm_env_rpc.
  • Initial set of compliance tests that environment authors can use to better ensure their implementations adhere to the protocol specification.
  • Support for dm_env DiscreteArray specs.

Changed

  • dm_env_rpc EnvironmentResponse errors in Python are now raised as a custom, DmEnvRpcError exception.

[1.0.0]

  • Initial release.

[1.0.0b2]

  • Updated minimum requirements for Python and protobuf.

[1.0.0b1]

  • Initial beta release