PalletDataGenerator

User Guide

  • Installation Guide
    • 🚀 System Requirements
      • Recommended Versions (Tested & Optimized)
      • Minimum Requirements
    • 📦 Installation Methods
      • Method 1: PyPI Installation (Recommended)
      • Method 2: Development Installation
      • Method 3: Using the Built-in Setup Command
    • 🎨 Blender Setup
      • Installing Blender
        • macOS
        • Linux (Ubuntu/Debian)
        • Windows
      • Verifying Blender Installation
    • 🔧 Virtual Environment Setup
      • Creating a Virtual Environment
      • Activating the Virtual Environment
        • Linux/macOS
        • Windows
      • Installing Dependencies
    • 🧪 Verification
      • Quick Test
      • Blender Integration Test
      • CLI Test
    • 🐛 Troubleshooting
      • Common Issues
        • 1. Python Version Compatibility
        • 2. Blender Python Path Issues
        • 3. GPU Issues
        • 4. Import Errors
      • Platform-Specific Issues
        • macOS
        • Linux
        • Windows
    • 📚 Next Steps
    • 🆘 Getting Help
  • Quick Start Guide
    • 🏃‍♂️ 5-Minute Quick Start
      • Step 1: Create Virtual Environment
      • Step 2: Prepare Your Blender Scene
      • Step 3: Generate Your First Dataset
        • With Blender (Recommended)
        • Direct Python (Limited)
      • Step 4: Check Your Results
    • 🎯 Common Use Cases
      • Single Pallet Scene
      • Warehouse Environment
      • With Custom Configuration
    • 📊 Understanding the Output
      • Directory Structure
      • Annotation Formats
        • YOLO Format
        • COCO Format
    • 🔧 CLI Command Reference
      • Basic Commands
      • Generation Options
    • 🎨 Blender Integration
      • Scene Setup Requirements
      • Launch Commands
      • Environment Variables
    • 🚨 Troubleshooting Quick Fixes
      • Common Issues
        • 1. “No pallet objects found”
        • 2. “Module not found” errors
        • 3. GPU not detected
        • 4. Empty output directory
    • 📈 Performance Tips
      • Speed Optimization
      • Quality Optimization
    • 🎯 Next Steps
    • 💡 Pro Tips
  • Keypoints Generation Feature
    • Overview
    • Keypoints Layout
    • Configuration
    • Output Format
      • Keypoints Labels (YOLO Format)
      • Example Keypoints File
    • Analysis Images
    • Usage Example
    • Face Detection
    • Visibility Detection
    • 3D Debug Visualization
      • Debug Output Structure
      • Coordinate Files
      • Interactive HTML Figures
      • Debug Images
    • Using Debug 3D Features
      • Interactive HTML Visualization
      • Coordinate Analysis
      • Example Usage
    • Integration with Existing Features
    • Troubleshooting
      • No keypoints generated
      • All keypoints marked as hidden
      • Keypoints in wrong positions
    • Advanced Configuration

API Reference

  • palletdatagenerator
    • palletdatagenerator package
      • Subpackages
        • palletdatagenerator.modes package
      • Submodules
        • palletdatagenerator.blender_runner module
        • palletdatagenerator.cli module
        • palletdatagenerator.config module
        • palletdatagenerator.generator module
        • palletdatagenerator.utils module
      • Module contents
        • PalletDataGenerator
        • DefaultConfig
        • setup_logging()
PalletDataGenerator
  • Overview: module code

All modules for which code is available

  • palletdatagenerator.blender_runner
  • palletdatagenerator.cli
  • palletdatagenerator.config
  • palletdatagenerator.generator
  • palletdatagenerator.modes.base_generator
  • palletdatagenerator.modes.single_pallet
  • palletdatagenerator.modes.warehouse
  • palletdatagenerator.utils

© Copyright 2025, Ibrahim Boubakri.

Built with Sphinx using a theme provided by Read the Docs.