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.
