torchwm 0.2.1__tar.gz

torchwm-0.2.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Param Thakkar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

torchwm-0.2.1/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: torchwm
+Version: 0.2.1
+Summary: A Modular Pytorch Based library for training world models
+Author: 
+License-Expression: MIT
+Keywords: world-models,pytorch,mbrl
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ale-py>=0.11.2
+Requires-Dist: gym>=0.26.2
+Requires-Dist: gymnasium>=1.2.2
+Requires-Dist: mlagents-envs>=0.28.0
+Requires-Dist: moviepy>=2.2.1
+Requires-Dist: myst-parser>=5.0.0
+Requires-Dist: nbsphinx>=0.9.8
+Requires-Dist: opencv-python>=4.12.0.88
+Requires-Dist: plotly>=6.5.0
+Requires-Dist: pre-commit>=4.5.0
+Requires-Dist: pygame>=2.6.1
+Requires-Dist: sphinx>=9.1.0
+Requires-Dist: sphinx-autodoc-typehints>=3.6.2
+Requires-Dist: sphinx-copybutton>=0.5.2
+Requires-Dist: sphinx-rtd-theme>=3.1.0
+Requires-Dist: sphinxcontrib-bibtex>=2.6.5
+Requires-Dist: sphinxext-opengraph>=0.13.0
+Requires-Dist: tensorboard>=2.20.0
+Requires-Dist: tensorboardx>=2.6.4
+Requires-Dist: tqdm>=4.67.1
+Dynamic: license-file
+Dynamic: requires-python
+
+# TorchWM
+
+A modular PyTorch library for learning, training, and deploying world models across various environments. This package provides minimal implementations of popular world model algorithms, enabling researchers and developers to experiment with predictive modeling in reinforcement learning and beyond.
+
+## Features
+
+- **Modular Design**: Easily extensible components for encoders, decoders, transition models, and reward predictors.
+- **Supported Algorithms**:
+  - Dreamer (v1 and v2 variants)
+  - PlaNet
+  - World Model-based agents for custom environments
+- **Integration**: Compatible with MuJoCo, Atari, and custom gym environments.
+- **Evaluation Tools**: Built-in scripts for training, evaluation, and visualization.
+- **PyTorch Native**: Leverages PyTorch's dynamic computation graphs for efficient training.
+
+## Installation
+
+### Prerequisites
+- Python 3.8+
+- PyTorch 1.9+
+- MuJoCo (for physics simulations)
+
+### Install from PyPI
+```bash
+pip install torchwm
+```
+
+### Install from Source
+Clone the repository and install in editable mode:
+```bash
+git clone https://github.com/ParamThakkar123/torchwm.git
+cd torchwm
+pip install -e .
+```
+
+For development dependencies (testing, linting):
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### Training a Dreamer Agent
+```python
+from world_models.dreamer import DreamerAgent
+import gym
+
+env = gym.make('Pendulum-v1')
+agent = DreamerAgent(env.observation_space, env.action_space)
+agent.train(env, num_episodes=1000)
+```
+
+### Evaluating a Trained Model
+Use the provided evaluation script:
+```bash
+python dreamer_eval.py --model_path results/dreamer_v1_custom_env/model.pth --env Pendulum-v1
+```
+
+### Custom Environment Example
+```python
+from world_models import WorldModel
+import torch
+
+# Define your custom environment
+class CustomEnv:
+    def __init__(self):
+        self.obs_dim = 10
+        self.act_dim = 2
+
+env = CustomEnv()
+model = WorldModel(obs_dim=env.obs_dim, act_dim=env.act_dim)
+# Train or load model...
+```
+
+## Project Structure
+
+- `world_models/`: Core library modules (encoders, decoders, agents)
+- `dreamer_eval.py`: Evaluation script for Dreamer agents
+- `dreamer_try.py`: Quick try-out script for Dreamer
+- `main.py`: Main entry point for training
+- `results/`: Directory for storing trained models and logs
+
+## Documentation
+
+For detailed API documentation, see the [Wiki](https://github.com/ParamThakkar123/torchwm/wiki) or docstrings in the source code.
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. Key areas:
+- Adding new world model algorithms
+- Improving existing implementations
+- Bug fixes and performance optimizations
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Citation
+
+If you use this library for your research, please cite:
+
+```bibtex
+@misc{Thakkar_GitHub_-_ParamThakkar123_torchwm,
+author = {Thakkar, Param},
+title = {{GitHub - ParamThakkar123/torchwm: A modular PyTorch library designed for learning, training, and deploying world models across various environments.}},
+year = {2025},
+url = {https://github.com/ParamThakkar123/torchwm}
+}
+```
+
+Package link: [TorchWM](https://pypi.org/project/torchwm/)

torchwm-0.2.1/README.md

@@ -0,0 +1,111 @@
+# TorchWM
+
+A modular PyTorch library for learning, training, and deploying world models across various environments. This package provides minimal implementations of popular world model algorithms, enabling researchers and developers to experiment with predictive modeling in reinforcement learning and beyond.
+
+## Features
+
+- **Modular Design**: Easily extensible components for encoders, decoders, transition models, and reward predictors.
+- **Supported Algorithms**:
+  - Dreamer (v1 and v2 variants)
+  - PlaNet
+  - World Model-based agents for custom environments
+- **Integration**: Compatible with MuJoCo, Atari, and custom gym environments.
+- **Evaluation Tools**: Built-in scripts for training, evaluation, and visualization.
+- **PyTorch Native**: Leverages PyTorch's dynamic computation graphs for efficient training.
+
+## Installation
+
+### Prerequisites
+- Python 3.8+
+- PyTorch 1.9+
+- MuJoCo (for physics simulations)
+
+### Install from PyPI
+```bash
+pip install torchwm
+```
+
+### Install from Source
+Clone the repository and install in editable mode:
+```bash
+git clone https://github.com/ParamThakkar123/torchwm.git
+cd torchwm
+pip install -e .
+```
+
+For development dependencies (testing, linting):
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### Training a Dreamer Agent
+```python
+from world_models.dreamer import DreamerAgent
+import gym
+
+env = gym.make('Pendulum-v1')
+agent = DreamerAgent(env.observation_space, env.action_space)
+agent.train(env, num_episodes=1000)
+```
+
+### Evaluating a Trained Model
+Use the provided evaluation script:
+```bash
+python dreamer_eval.py --model_path results/dreamer_v1_custom_env/model.pth --env Pendulum-v1
+```
+
+### Custom Environment Example
+```python
+from world_models import WorldModel
+import torch
+
+# Define your custom environment
+class CustomEnv:
+    def __init__(self):
+        self.obs_dim = 10
+        self.act_dim = 2
+
+env = CustomEnv()
+model = WorldModel(obs_dim=env.obs_dim, act_dim=env.act_dim)
+# Train or load model...
+```
+
+## Project Structure
+
+- `world_models/`: Core library modules (encoders, decoders, agents)
+- `dreamer_eval.py`: Evaluation script for Dreamer agents
+- `dreamer_try.py`: Quick try-out script for Dreamer
+- `main.py`: Main entry point for training
+- `results/`: Directory for storing trained models and logs
+
+## Documentation
+
+For detailed API documentation, see the [Wiki](https://github.com/ParamThakkar123/torchwm/wiki) or docstrings in the source code.
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. Key areas:
+- Adding new world model algorithms
+- Improving existing implementations
+- Bug fixes and performance optimizations
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Citation
+
+If you use this library for your research, please cite:
+
+```bibtex
+@misc{Thakkar_GitHub_-_ParamThakkar123_torchwm,
+author = {Thakkar, Param},
+title = {{GitHub - ParamThakkar123/torchwm: A modular PyTorch library designed for learning, training, and deploying world models across various environments.}},
+year = {2025},
+url = {https://github.com/ParamThakkar123/torchwm}
+}
+```
+
+Package link: [TorchWM](https://pypi.org/project/torchwm/)

torchwm-0.2.1/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "torchwm"
+version = "0.2.1"
+description = "A Modular Pytorch Based library for training world models"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "ale-py>=0.11.2",
+    "gym>=0.26.2",
+    "gymnasium>=1.2.2",
+    "mlagents-envs>=0.28.0",
+    "moviepy>=2.2.1",
+    "myst-parser>=5.0.0",
+    "nbsphinx>=0.9.8",
+    "opencv-python>=4.12.0.88",
+    "plotly>=6.5.0",
+    "pre-commit>=4.5.0",
+    "pygame>=2.6.1",
+    "sphinx>=9.1.0",
+    "sphinx-autodoc-typehints>=3.6.2",
+    "sphinx-copybutton>=0.5.2",
+    "sphinx-rtd-theme>=3.1.0",
+    "sphinxcontrib-bibtex>=2.6.5",
+    "sphinxext-opengraph>=0.13.0",
+    "tensorboard>=2.20.0",
+    "tensorboardx>=2.6.4",
+    "tqdm>=4.67.1",
+]
+license = "MIT"
+keywords = ["world-models", "pytorch", "mbrl"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel", "build"]
+build-backend = "setuptools.build_meta"

torchwm-0.2.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

torchwm-0.2.1/setup.py

@@ -0,0 +1,46 @@
+from pathlib import Path
+from setuptools import setup, find_packages
+
+HERE = Path(__file__).parent
+
+README = (
+    (HERE / "README.md").read_text(encoding="utf-8")
+    if (HERE / "README.md").exists()
+    else ""
+)
+
+setup(
+    name="torchwm",
+    version="0.1.0",
+    description="A Pytorch Based library for training world models",
+    long_description=README,
+    long_description_content_type="text/markdown",
+    author="",
+    license="MIT",
+    packages=find_packages(exclude=("tests", "results", "envs", ".venv", "venv")),
+    include_package_data=True,
+    python_requires=">=3.13",
+    install_requires=[
+        "ale-py>=0.11.2",
+        "gym>=0.26.2",
+        "gymnasium>=1.2.2",
+        "mlagents-envs>=0.28.0",
+        "moviepy>=2.2.1",
+        "opencv-python>=4.12.0.88",
+        "plotly>=6.5.0",
+        "pre-commit>=4.5.0",
+        "pygame>=2.6.1",
+        "tensorboard>=2.20.0",
+        "tensorboardx>=2.6.4",
+        "tqdm>=4.67.1",
+        "torch>=1.13.0",
+        "torchvision>=0.14.0",
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    keywords="world-models pytorch",
+    zip_safe=False,
+)

torchwm-0.2.1/tests/test_envs.py

@@ -0,0 +1,30 @@
+from world_models.envs.dmc import DeepMindControlEnv
+
+
+class TestDeepMindControlEnv:
+    def test_env_creation(self):
+        env = DeepMindControlEnv(name="cartpole-swingup", seed=42, size=(64, 64))
+        assert env.observation_space is not None
+        assert env.action_space is not None
+
+    def test_env_step_and_reset(self):
+        env = DeepMindControlEnv(name="cartpole-swingup", seed=42, size=(64, 64))
+        obs = env.reset()
+        assert "image" in obs
+        action = env.action_space.sample()
+        next_obs, reward, done, info = env.step(action)
+        assert "image" in next_obs
+        assert isinstance(reward, float)
+        assert isinstance(done, bool)
+        assert "discount" in info
+
+    def test_env_render(self):
+        env = DeepMindControlEnv(name="cartpole-swingup", seed=42, size=(64, 64))
+        env.reset()
+        frame = env.render()
+        assert frame.shape == (64, 64, 3)
+        env.close()
+
+
+class TestMujocoEnv:
+    pass

torchwm-0.2.1/torchwm.egg-info/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: torchwm
+Version: 0.2.1
+Summary: A Modular Pytorch Based library for training world models
+Author: 
+License-Expression: MIT
+Keywords: world-models,pytorch,mbrl
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ale-py>=0.11.2
+Requires-Dist: gym>=0.26.2
+Requires-Dist: gymnasium>=1.2.2
+Requires-Dist: mlagents-envs>=0.28.0
+Requires-Dist: moviepy>=2.2.1
+Requires-Dist: myst-parser>=5.0.0
+Requires-Dist: nbsphinx>=0.9.8
+Requires-Dist: opencv-python>=4.12.0.88
+Requires-Dist: plotly>=6.5.0
+Requires-Dist: pre-commit>=4.5.0
+Requires-Dist: pygame>=2.6.1
+Requires-Dist: sphinx>=9.1.0
+Requires-Dist: sphinx-autodoc-typehints>=3.6.2
+Requires-Dist: sphinx-copybutton>=0.5.2
+Requires-Dist: sphinx-rtd-theme>=3.1.0
+Requires-Dist: sphinxcontrib-bibtex>=2.6.5
+Requires-Dist: sphinxext-opengraph>=0.13.0
+Requires-Dist: tensorboard>=2.20.0
+Requires-Dist: tensorboardx>=2.6.4
+Requires-Dist: tqdm>=4.67.1
+Dynamic: license-file
+Dynamic: requires-python
+
+# TorchWM
+
+A modular PyTorch library for learning, training, and deploying world models across various environments. This package provides minimal implementations of popular world model algorithms, enabling researchers and developers to experiment with predictive modeling in reinforcement learning and beyond.
+
+## Features
+
+- **Modular Design**: Easily extensible components for encoders, decoders, transition models, and reward predictors.
+- **Supported Algorithms**:
+  - Dreamer (v1 and v2 variants)
+  - PlaNet
+  - World Model-based agents for custom environments
+- **Integration**: Compatible with MuJoCo, Atari, and custom gym environments.
+- **Evaluation Tools**: Built-in scripts for training, evaluation, and visualization.
+- **PyTorch Native**: Leverages PyTorch's dynamic computation graphs for efficient training.
+
+## Installation
+
+### Prerequisites
+- Python 3.8+
+- PyTorch 1.9+
+- MuJoCo (for physics simulations)
+
+### Install from PyPI
+```bash
+pip install torchwm
+```
+
+### Install from Source
+Clone the repository and install in editable mode:
+```bash
+git clone https://github.com/ParamThakkar123/torchwm.git
+cd torchwm
+pip install -e .
+```
+
+For development dependencies (testing, linting):
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### Training a Dreamer Agent
+```python
+from world_models.dreamer import DreamerAgent
+import gym
+
+env = gym.make('Pendulum-v1')
+agent = DreamerAgent(env.observation_space, env.action_space)
+agent.train(env, num_episodes=1000)
+```
+
+### Evaluating a Trained Model
+Use the provided evaluation script:
+```bash
+python dreamer_eval.py --model_path results/dreamer_v1_custom_env/model.pth --env Pendulum-v1
+```
+
+### Custom Environment Example
+```python
+from world_models import WorldModel
+import torch
+
+# Define your custom environment
+class CustomEnv:
+    def __init__(self):
+        self.obs_dim = 10
+        self.act_dim = 2
+
+env = CustomEnv()
+model = WorldModel(obs_dim=env.obs_dim, act_dim=env.act_dim)
+# Train or load model...
+```
+
+## Project Structure
+
+- `world_models/`: Core library modules (encoders, decoders, agents)
+- `dreamer_eval.py`: Evaluation script for Dreamer agents
+- `dreamer_try.py`: Quick try-out script for Dreamer
+- `main.py`: Main entry point for training
+- `results/`: Directory for storing trained models and logs
+
+## Documentation
+
+For detailed API documentation, see the [Wiki](https://github.com/ParamThakkar123/torchwm/wiki) or docstrings in the source code.
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. Key areas:
+- Adding new world model algorithms
+- Improving existing implementations
+- Bug fixes and performance optimizations
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Citation
+
+If you use this library for your research, please cite:
+
+```bibtex
+@misc{Thakkar_GitHub_-_ParamThakkar123_torchwm,
+author = {Thakkar, Param},
+title = {{GitHub - ParamThakkar123/torchwm: A modular PyTorch library designed for learning, training, and deploying world models across various environments.}},
+year = {2025},
+url = {https://github.com/ParamThakkar123/torchwm}
+}
+```
+
+Package link: [TorchWM](https://pypi.org/project/torchwm/)

torchwm-0.2.1/torchwm.egg-info/SOURCES.txt

@@ -0,0 +1,62 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+tests/test_agents.py
+tests/test_controller.py
+tests/test_decoder.py
+tests/test_encoder.py
+tests/test_envs.py
+tests/test_memory.py
+tests/test_observations.py
+tests/test_rewards.py
+tests/test_trainers.py
+tests/test_transforms.py
+tests/test_utils.py
+torchwm.egg-info/PKG-INFO
+torchwm.egg-info/SOURCES.txt
+torchwm.egg-info/dependency_links.txt
+torchwm.egg-info/not-zip-safe
+torchwm.egg-info/requires.txt
+torchwm.egg-info/top_level.txt
+world_models/__init__.py
+world_models/controller/__init__.py
+world_models/controller/rollout_generator.py
+world_models/controller/rssm_policy.py
+world_models/datasets/__init__.py
+world_models/datasets/cifar10.py
+world_models/datasets/imagenet1k.py
+world_models/datasets/nuplan.py
+world_models/envs/__init__.py
+world_models/envs/ale_atari_env.py
+world_models/envs/ale_atari_vector_env.py
+world_models/envs/dmc.py
+world_models/envs/mujoco_env.py
+world_models/envs/unity_env.py
+world_models/envs/wrappers.py
+world_models/memory/__init__.py
+world_models/memory/dreamer_memory.py
+world_models/memory/planet_memory.py
+world_models/models/__init__.py
+world_models/models/dreamer.py
+world_models/models/dreamer_rssm.py
+world_models/models/jepa_agent.py
+world_models/models/planet.py
+world_models/models/rssm.py
+world_models/models/vit.py
+world_models/reward/__init__.py
+world_models/reward/dreamer_v1_reward.py
+world_models/reward/dreamer_v1_value.py
+world_models/training/__init__.py
+world_models/training/train_jepa.py
+world_models/training/train_planet.py
+world_models/training/train_rssm.py
+world_models/utils/__init__.py
+world_models/utils/dreamer_utils.py
+world_models/utils/jepa_utils.py
+world_models/utils/utils.py
+world_models/vision/__init__.py
+world_models/vision/dreamer_decoder.py
+world_models/vision/dreamer_encoder.py
+world_models/vision/planet_decoder.py
+world_models/vision/planet_encoder.py

torchwm-0.2.1/torchwm.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

torchwm-0.2.1/torchwm.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

torchwm-0.2.1/torchwm.egg-info/requires.txt

@@ -0,0 +1,20 @@
+ale-py>=0.11.2
+gym>=0.26.2
+gymnasium>=1.2.2
+mlagents-envs>=0.28.0
+moviepy>=2.2.1
+myst-parser>=5.0.0
+nbsphinx>=0.9.8
+opencv-python>=4.12.0.88
+plotly>=6.5.0
+pre-commit>=4.5.0
+pygame>=2.6.1
+sphinx>=9.1.0
+sphinx-autodoc-typehints>=3.6.2
+sphinx-copybutton>=0.5.2
+sphinx-rtd-theme>=3.1.0
+sphinxcontrib-bibtex>=2.6.5
+sphinxext-opengraph>=0.13.0
+tensorboard>=2.20.0
+tensorboardx>=2.6.4
+tqdm>=4.67.1

torchwm-0.2.1/torchwm.egg-info/top_level.txt

@@ -0,0 +1 @@
+world_models