lit_sb3.vec_env.vec_video_recorder

source module lit_sb3.vec_env.vec_video_recorder

Classes

• VecVideoRecorder — Wraps a VecEnv or VecEnvWrapper object to record rendered image as mp4 video.

source class VecVideoRecorder(venv: VecEnv, video_folder: str | Path, record_video_trigger: Callable[[int], bool], video_length: int = 200, name_prefix: str = 'rl-video')

Bases : VecEnvWrapper

Wraps a VecEnv or VecEnvWrapper object to record rendered image as mp4 video.

It requires ffmpeg or avconv to be installed on the machine.

Note: for now it only allows to record one video and all videos must have at least two frames.

The video recorder code was adapted from Gymnasium v1.0.

Parameters

• venv : VecEnv

• video_folder : str | Path — Where to save videos

• record_video_trigger : Callable[[int], bool] — Function that defines when to start recording. The function takes the current number of step, and returns whether we should start recording or not.

• video_length : int — Length of recorded videos

• name_prefix : str — Prefix to the video name

Methods

• reset

• step_wait

• close — Closes the wrapper then the video recorder.

source method VecVideoRecorder.reset() → VecEnvObs

source method VecVideoRecorder.step_wait() → VecEnvStepReturn

source method VecVideoRecorder.close() → None

Closes the wrapper then the video recorder.