Skip to content
SatenoPublic

About

Tools and examples for advanced educational reinforcement-learning videos, based on Manim Voiceover.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

RL Studio

Tools and examples for advanced educational reinforcement-learning videos, based on Manim Voiceover v0.4.0.

The initial baseline includes a reproducible WSL2/Ubuntu setup, Conda Python 3.12, uv-locked dependencies, focused upstream tests, and a short mathematical lesson with local narration. The Python package remains manim-voiceover / manim_voiceover; the upstream source and MIT notices are preserved.

Validation status: Local WAV Narration passed 237 full-suite tests (97.85% coverage), all 3,468 mutation checks, formatting, lint, type checks, the dependency audit and Slophammer. Its focused workflow passed 158 tests and both verified A/B renders. Historical records are kept unchanged in docs/history: the Local WAV Narration integration validation, the baseline validation and the task-sandbox record.

Use main for Windows production and dev as the base for Taiga tasks. Both branches support native Windows and Linux. Test changes on both platforms before merging dev into main. See local setup and validation for setup.

From Anaconda Prompt with rl_studio_win active:

powershell.exe -NoProfile -File .\local.ps1 test-all
powershell.exe -NoProfile -File .\local.ps1 bookmarks

From PowerShell, use local-wsl.ps1 to run the Linux commands through WSL:

.\local-wsl.ps1 status
.\local-wsl.ps1 setup
.\local-wsl.ps1 test
.\local-wsl.ps1 demo local-wav
.\local-wsl.ps1 demo cue-bindings
.\local-wsl.ps1 demo bookmarks
.\local-wsl.ps1 render
.\local-wsl.ps1 shell

In Linux or WSL, the same operations are:

bash scripts/dev.sh setup
bash scripts/dev.sh test
bash scripts/dev.sh demo local-wav
bash scripts/dev.sh demo cue-bindings
bash scripts/dev.sh demo bookmarks
UV_NO_DEV=1 uv run --frozen pytest -v tests/test_render_workflow.py      # one test file on its own
UV_NO_DEV=1 uv run --frozen pytest -v tests/test_local_wav_bookmarks.py

Scenes and recording fixtures are under examples/rl_lessons/. Rendered media and local environment files are excluded from Git. Features:

  • Local WAV Narration (local_wav, demo local-wav): LocalWavService plays mono/stereo 16-bit PCM WAV narration. See docs/local_wav.md.
  • Cue Bindings (cue_bindings, demo cue-bindings): stable cue IDs bound to recordings by a JSON manifest. See docs/cue_bindings.md.
  • Manual Narration Bookmarks (local_wav_bookmarks, demo bookmarks): named times in a recording; a scene waits for a bookmark and triggers an animation. See docs/local_wav_bookmarks.md.

Videos and verification reports are written to media/local_wav/, media/cue_bindings/ and media/bookmarks/ (media/bookmarks/verification.json).

The upstream release-publishing workflow is restricted to the upstream repository. RL Studio does not publish the manim-voiceover package to PyPI.

Upstream project

The original project overview follows; its badges and links refer to Manim Voiceover.

Manim Voiceover

Github Actions Status PyPI Latest Release Downloads Documentation Status License Discord

Manim Voiceover is a Manim plugin for all things voiceover:

  • Add voiceovers to Manim videos directly in Python without having to use a video editor.
  • Record voiceovers with your microphone during rendering with a simple command line interface.
  • Develop animations with auto-generated AI voices from various free and proprietary services.
  • Per-word timing of animations, i.e. trigger animations at specific words in the voiceover, even for the recordings. This works thanks to OpenAI Whisper.

Here is a demo:

VoiceoverDemo-gemini.mp4

Currently supported TTS services (aside from the CLI that allows you to records your own voice):

Check out the documentation for more details.

Installation

Installation instructions in Manim Voiceover docs.

Get started

Check out the docs to get started with Manim Voiceover.

Examples

Check out the example gallery to get inspired.

Translate

Manim Voiceover can use machine translation services like DeepL to translate voiceovers into other languages. Check out the docs for more details.

About

Tools and examples for advanced educational reinforcement-learning videos, based on Manim Voiceover.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages