schola.core.spaces.base.UnrealSpace

class schola.core.spaces.base.UnrealSpace[source]

Bases: object

A base class for all spaces in Schola, providing a common interface for converting between protobuf messages and pythonic representations.

_name

The name of the space.

Type:

str

See also

gymnasium.spaces.Space

The gym space object that this class is analogous to.

Methods

__init__()
fill_proto(msg, value)	Convert a python representation of point in this space to a protobuf message.
from_proto(message)	Create a Space Object from a protobuf representation.
is_empty_definition(message)	Returns True iff this space has magnitude 0.
merge(*spaces)
process_data(msg)	Convert a protobuf message corresponding to a point in this space to a pythonic representation.
to_normalized()	Returns a normalized version of the space.

Attributes

proto_space

A class variable containing the protobuf representation of the space.

fill_proto(msg, value)[source]

Convert a python representation of point in this space to a protobuf message. Mutates msg with the result.

Parameters:

• msg (proto_points.FundamentalPoint) – The protobuf message to fill.

• value (Any) – The pythonic representation of the point.

Return type:

None

classmethod from_proto(message)[source]

Create a Space Object from a protobuf representation.

Parameters:

message (proto_space) – The protobuf message to convert.

Returns:

The Space subclass created from the protobuf message

Return type:

UnrealSpace

classmethod is_empty_definition(message)[source]

Returns True iff this space has magnitude 0.

Parameters:

message (proto_space) – The protobuf message to check for emptiness.

Returns:

True iff the space is empty.

Return type:

bool

classmethod merge(*spaces)[source]

Parameters:

spaces (List[UnrealSpace])

Return type:

UnrealSpace

process_data(msg)[source]

Convert a protobuf message corresponding to a point in this space to a pythonic representation.

Parameters:

msg (proto_points.FundamentalPoint) – The protobuf message to convert.

Returns:

The pythonic representation of the point.

Return type:

np.ndarray

proto_space: Type[FundamentalSpace] = None

A class variable containing the protobuf representation of the space.

to_normalized()[source]

Returns a normalized version of the space. Is a noop if a space subclass does not implement to_normalized.

Returns:

The normalized space.

Return type:

UnrealSpace