robocandywrapper 0.2.1__tar.gz

robocandywrapper-0.2.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ville Kuosmanen
+
+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.

robocandywrapper-0.2.1/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include robocandywrapper *.py
+

robocandywrapper-0.2.1/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: robocandywrapper
+Version: 0.2.1
+Summary: Sweet wrappers for extending and remixing LeRobot Datasets
+Author: RoboCandyWrapper Contributors
+License: MIT License
+        
+        Copyright (c) 2025 Ville Kuosmanen
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/yourusername/RoboCandyWrapper
+Project-URL: Repository, https://github.com/yourusername/RoboCandyWrapper
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: torch>=2.0.0
+Requires-Dist: lerobot<0.5,>=0.4
+Requires-Dist: pandas>=1.3.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.10.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Dynamic: license-file
+Dynamic: requires-python
+
+# 🍬 RoboCandyWrapper
+
+**Sweet wrappers for extending and remixing LeRobot Datasets.**
+
+---
+
+## 🍬 Why do I need this?
+
+You have robot data. Lots of it. But it's messy:
+*   Some datasets are from the "old days" (v2.1 dataset).
+*   Some are brand new (v3.0 dataset).
+*   You want to mix various data sources as needed, without permanently merging them.
+
+Traditionally, you'd have to write complex scripts to convert everything to a single format. **RoboCandyWrapper** handles that compatibility layer for you. It wraps your datasets in a sweet, consistent interface so you can focus on training, not data plumbing.
+
+Additionally, you might want to extend your datasets with additional labels and columns without breaking backwards compatibility of data or code with LeRobot. RoboCandyWrapper provides an extendible **Adapter** system to add new data to existing datasets, load any number of adapters during training, and mixing data between adapters.
+
+RoboCandyWrapper also includes a **Sampler** system to change the ratio of sampling between multiple data sources, so you can increase or decrease the weight of specific datasets in your data mix as needed.
+
+RoboCandyWrapper is still experimental so do note that the library API could change in the future although we'll do our best to avoid unnecessary changes!
+
+## 🍬 Quick Start (5 Minutes)
+
+### Installation
+```bash
+# Include LeRobot as a dependency in installation
+pip install robocandywrapper
+
+# OR...
+# Use your own version of LeRobot - may cause issues!
+pip install --no-dependencies robocandywrapper
+
+# OR...
+# Use your own version of LeRobot and install robocandywrapper as a local editable dependency so you change LeRobot imports as needed
+# This might be required if you use a LeRobot fork or depend on an out of date version
+git clone https://github.com/villekuosmanen/RoboCandyWrapper.git
+cd RoboCandyWrapper
+pip install --no-dependencies -e .
+```
+
+### Basic usage
+Load a vintage v2.1 dataset and a modern v3.0 dataset as if they were the same thing.
+
+```python
+from robocandywrapper import make_dataset_without_config
+
+# Your playlist: one old, one new
+repo_ids = [
+    "lerobot/svla_so100_pickplace",  # v2.1 dataset
+    "lerobot/svla_so100_stacking",   # v3.0 dataset
+]
+
+# The factory handles the compatibility logic automatically
+dataset = make_dataset_without_config(repo_ids)
+
+print(f"🎉 Successfully loaded {len(dataset)} episodes from mixed sources!")
+```
+
+## 🍬 What more can I do with it?
+
+### 🎧 [The "Mix Tape" (Mixing Datasets)](docs/guide_mixing_datasets.md)
+Learn how to combine multiple datasets into one, handle different robot configurations, and use sampling weights to balance your data mix.
+
+### 🧂 [The "Flavor Enhancer" (Transforming Data)](docs/guide_transforming_data.md)
+Learn how to use **Plugins** to add new labels or columns to your dataset, reshape tensors, or modify existing data on-the-fly without breaking backwards compatability.
+
+## Other cool stuff from the authors
+
+1. [Physical AI Interpretability](https://github.com/villekuosmanen/physical-AI-interpretability) offers open-source interpretability tools for AI robotics.  
+2. [RewACT](https://github.com/villekuosmanen/rewACT) is an open-source reward model / value function based on the ACT transformer architecture.

robocandywrapper-0.2.1/README.md

@@ -0,0 +1,70 @@
+# 🍬 RoboCandyWrapper
+
+**Sweet wrappers for extending and remixing LeRobot Datasets.**
+
+---
+
+## 🍬 Why do I need this?
+
+You have robot data. Lots of it. But it's messy:
+*   Some datasets are from the "old days" (v2.1 dataset).
+*   Some are brand new (v3.0 dataset).
+*   You want to mix various data sources as needed, without permanently merging them.
+
+Traditionally, you'd have to write complex scripts to convert everything to a single format. **RoboCandyWrapper** handles that compatibility layer for you. It wraps your datasets in a sweet, consistent interface so you can focus on training, not data plumbing.
+
+Additionally, you might want to extend your datasets with additional labels and columns without breaking backwards compatibility of data or code with LeRobot. RoboCandyWrapper provides an extendible **Adapter** system to add new data to existing datasets, load any number of adapters during training, and mixing data between adapters.
+
+RoboCandyWrapper also includes a **Sampler** system to change the ratio of sampling between multiple data sources, so you can increase or decrease the weight of specific datasets in your data mix as needed.
+
+RoboCandyWrapper is still experimental so do note that the library API could change in the future although we'll do our best to avoid unnecessary changes!
+
+## 🍬 Quick Start (5 Minutes)
+
+### Installation
+```bash
+# Include LeRobot as a dependency in installation
+pip install robocandywrapper
+
+# OR...
+# Use your own version of LeRobot - may cause issues!
+pip install --no-dependencies robocandywrapper
+
+# OR...
+# Use your own version of LeRobot and install robocandywrapper as a local editable dependency so you change LeRobot imports as needed
+# This might be required if you use a LeRobot fork or depend on an out of date version
+git clone https://github.com/villekuosmanen/RoboCandyWrapper.git
+cd RoboCandyWrapper
+pip install --no-dependencies -e .
+```
+
+### Basic usage
+Load a vintage v2.1 dataset and a modern v3.0 dataset as if they were the same thing.
+
+```python
+from robocandywrapper import make_dataset_without_config
+
+# Your playlist: one old, one new
+repo_ids = [
+    "lerobot/svla_so100_pickplace",  # v2.1 dataset
+    "lerobot/svla_so100_stacking",   # v3.0 dataset
+]
+
+# The factory handles the compatibility logic automatically
+dataset = make_dataset_without_config(repo_ids)
+
+print(f"🎉 Successfully loaded {len(dataset)} episodes from mixed sources!")
+```
+
+## 🍬 What more can I do with it?
+
+### 🎧 [The "Mix Tape" (Mixing Datasets)](docs/guide_mixing_datasets.md)
+Learn how to combine multiple datasets into one, handle different robot configurations, and use sampling weights to balance your data mix.
+
+### 🧂 [The "Flavor Enhancer" (Transforming Data)](docs/guide_transforming_data.md)
+Learn how to use **Plugins** to add new labels or columns to your dataset, reshape tensors, or modify existing data on-the-fly without breaking backwards compatability.
+
+## Other cool stuff from the authors
+
+1. [Physical AI Interpretability](https://github.com/villekuosmanen/physical-AI-interpretability) offers open-source interpretability tools for AI robotics.  
+2. [RewACT](https://github.com/villekuosmanen/rewACT) is an open-source reward model / value function based on the ACT transformer architecture.

robocandywrapper-0.2.1/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "robocandywrapper"
+version = "0.2.1"
+description = "Sweet wrappers for extending and remixing LeRobot Datasets"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {file = "LICENSE"}
+authors = [
+    {name = "RoboCandyWrapper Contributors"}
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = [
+    "numpy>=1.20.0",
+    "torch>=2.0.0",
+    "lerobot>=0.4,<0.5",
+    "pandas>=1.3.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "black>=22.0.0",
+    "isort>=5.10.0",
+    "flake8>=4.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/yourusername/RoboCandyWrapper"
+Repository = "https://github.com/yourusername/RoboCandyWrapper"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["robocandywrapper*"]
+exclude = ["examples*", "tests*"]
+
+[tool.black]
+line-length = 100
+target-version = ['py310']
+
+[tool.isort]
+profile = "black"
+line_length = 100
+

robocandywrapper-0.2.1/robocandywrapper/__init__.py

@@ -0,0 +1,36 @@
+"""RoboCandyWrapper - Extensible dataset wrapper for LeRobot datasets."""
+
+from robocandywrapper.plugin import (
+    DatasetPlugin,
+    PluginInstance,
+    PluginConflictError,
+)
+from robocandywrapper.wrapper import WrappedRobotDataset
+from robocandywrapper.metadata_view import WrappedRobotDatasetMetadataView
+from robocandywrapper.samplers.weighted import WeightedSampler
+from robocandywrapper.samplers.factory import make_sampler
+from robocandywrapper.factory import make_dataset_without_config, make_dataset
+from robocandywrapper.utils import WandBLogger
+from robocandywrapper.constants import (
+    CANDYWRAPPER_PLUGINS_DIR,
+    AFFORDANCE_PLUGIN_NAME,
+    EPISODE_OUTCOME_PLUGIN_NAME,
+)
+
+__version__ = "0.2.1"
+
+__all__ = [
+    "DatasetPlugin",
+    "PluginInstance",
+    "PluginConflictError",
+    "WrappedRobotDataset",
+    "WrappedRobotDatasetMetadataView",
+    "WeightedSampler",
+    "make_sampler",
+    "make_dataset_without_config",
+    "make_dataset",
+    "WandBLogger",
+    "CANDYWRAPPER_PLUGINS_DIR",
+    "AFFORDANCE_PLUGIN_NAME",
+    "EPISODE_OUTCOME_PLUGIN_NAME",
+]

robocandywrapper-0.2.1/robocandywrapper/constants.py

@@ -0,0 +1,14 @@
+"""
+Constants for RoboCandyWrapper plugins and data storage.
+"""
+
+# Plugin storage directory (relative to dataset root)
+CANDYWRAPPER_PLUGINS_DIR = "candywrapper_plugins"
+
+# Plugin-specific subdirectory names
+AFFORDANCE_PLUGIN_NAME = "affordance"
+EPISODE_OUTCOME_PLUGIN_NAME = "episode_outcome"
+# Add more plugin names here as needed
+# GOAL_PLUGIN_NAME = "goal"
+# LANGUAGE_PLUGIN_NAME = "language"
+

robocandywrapper-0.2.1/robocandywrapper/dataformats/lerobot_21/__init__.py

@@ -0,0 +1,32 @@
+from .dataset import LeRobot21Dataset, LeRobot21DatasetMetadata
+from .utils import (
+    load_tasks,
+    load_episodes,
+    append_jsonlines,
+    load_jsonlines,
+    serialize_dict,
+    cast_stats_to_numpy,
+    write_episode,
+    write_episode_stats,
+    load_episodes_stats,
+    backward_compatible_episodes_stats,
+    get_episode_data_index,
+    check_timestamps_sync,
+)
+
+__all__ = [
+    "LeRobot21Dataset",
+    "LeRobot21DatasetMetadata",
+    "load_tasks",
+    "load_episodes",
+    "append_jsonlines",
+    "load_jsonlines",
+    "serialize_dict",
+    "cast_stats_to_numpy",
+    "write_episode",
+    "write_episode_stats",
+    "load_episodes_stats",
+    "backward_compatible_episodes_stats",
+    "get_episode_data_index",
+    "check_timestamps_sync",
+]