Skip to content

API Reference

Welcome to the VibeRL API documentation. This section provides file-level documentation matching the exact structure of the source code.

File Structure

Each .py file in the source code has a corresponding .md file in this documentation:

viberl/
├── agents/
│   ├── base.py → base.md
│   ├── reinforce.py → reinforce.md
│   ├── dqn.py → dqn.md
│   └── ppo.py → ppo.md
├── networks/
│   ├── base_network.py → base_network.md
│   ├── policy_network.py → policy_network.md
│   └── value_network.py → value_network.md
├── envs/
│   └── grid_world/
│       └── snake_env.py → grid_world/snake_env.md
├── utils/
│   ├── common.py → common.md
│   ├── training.py → training.md
│   ├── mock_env.py → mock_env.md
│   └── experiment_manager.py → experiment_manager.md
├── typing.py → typing.md
└── cli.py → cli.md

Each page contains: 1. Module Overview - File-level documentation with hyperlinks 2. Classes & Functions - Detailed documentation for all classes and functions in the file

Click on any file in the navigation menu to explore its contents.