Create synthetic data with Blender.
Project description
Abstract
Collecting, labeling, and cleaning data for computer vision is a pain. Jump into the future and create your own data instead! Synthetic data is faster to develop with, effectively infinite, and gives you full control to prevent bias and privacy issues from creeping in. We created zpy
to make synthetic data easy, by simplifying the simulation (sim) creation process and providing an easy way to generate synthetic data at scale.
Install
- Install using pip (Windows/Mac/Linux).
- Install Blender Addon from .zip (Windows/Mac/Linux).
- Install from script (Mac/Linux)
- Developer mode (Linux)
- Developer mode (Windows)
Install: Using Pip
You can install zpy
with pip:
pip install zpy-zumo
Note that Blender has it's own python, seperate from your system/venv/conda python. You will have to install it into both.
Install: Blender Addon
Once you have installed the zpy
module into Blender's python, download the latest zip (you want the one called zpy_addon-v*.zip
). Then open up Blender. Navigate to Edit
-> Preferences
-> Add-ons
. You should be able to install and enable the addon from there.
Install: Linux: Using Install Script
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ZumoLabs/zpy/main/install.sh)"
Set these environment variables for specific versions:
export BLENDER_VERSION="2.92"
export BLENDER_VERSION_FULL="2.92.0"
export ZPY_VERSION="v1.1.3"
CLI
We provide a simple CLI. In order to run pip install zpy-zumo and then just run commands in that python environment.
You can find documentation here.
Examples
Video Tutorials
- Loading the zpy Blender Add-On
- Run a Sim
- Using Script Templates
- Segmentation Images
- Depth Images
- Jittering Materials
- Jittering Object Pose
- Random HDRI Backgrounds
Projects
Video Code-Alongs
Documentation
Code documentation can be found here
Contributing
We welcome community contributions! Search through the current issues or open your own.
Licence
This release of zpy is under the GPLv3 license, a free copyleft license used by Blender. TLDR: Its free, use it!
BibTeX
If you use zpy
in your research, we would appreciate the citation!
@article{zpy,
title={zpy: Synthetic data for Blender.},
author={Ponte, H. and Ponte, N. and Karatas, K},
journal={GitHub. Note: https://github.com/ZumoLabs/zpy},
volume={1},
year={2020}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.