unreal.LearningAgentsRecording

class unreal.LearningAgentsRecording(outer: Object | None = None, name: Name | str = 'None')

Bases: DataAsset

Data asset representing an array of records.

C++ Source:

  • Plugin: LearningAgents

  • Module: LearningAgentsTraining

  • File: LearningAgentsRecording.h

Editor Properties: (see get_editor_property/set_editor_property)

  • records (Array[LearningAgentsRecord]): [Read-Write] Set of records.

append_recording_from_file(file) None

Append to this recording from a file.

Parameters:

file (FilePath) –

append_recording_to_asset(recording_asset) None

Appends this recording to the given recording asset

Parameters:

recording_asset (LearningAgentsRecording) –

get_action_vector(record, step) -> (out_action_vector=Array[float], out_action_compatibility_hash=int32)

Get the Action Vector associated with a particular step of a given recording

Parameters:
  • record (int32) – Index of the record in the array of records.

  • step (int32) – Step of the recording

Returns:

out_action_vector (Array[float]): Output Action Vector

out_action_compatibility_hash (int32): Output Compatibility Hash for the given Action Vector

Return type:

tuple

get_observation_vector(record, step) -> (out_observation_vector=Array[float], out_observation_compatibility_hash=int32)

Get the Observation Vector associated with a particular step of a given recording

Parameters:
  • record (int32) – Index of the record in the array of records.

  • step (int32) – Step of the recording

Returns:

out_observation_vector (Array[float]): Output Observation Vector

out_observation_compatibility_hash (int32): Output Compatibility Hash for the given Observation Vector

Return type:

tuple

get_record_num() int32

Get the number of records

Return type:

int32

get_record_step_num(record) int32

Get the number of steps in a given record

Parameters:

record (int32) –

Return type:

int32

load_recording_from_asset(recording_asset) None

Loads this recording from the given recording asset

Parameters:

recording_asset (LearningAgentsRecording) –

load_recording_from_file(file) None

Load this recording from a file.

Parameters:

file (FilePath) –

save_recording_to_asset(recording_asset) None

Saves this recording to the given recording asset

Parameters:

recording_asset (LearningAgentsRecording) –

save_recording_to_file(file) None

Save this recording to a file.

Parameters:

file (FilePath) –