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
  • palletdatagenerator
  • Edit on GitHub

palletdatagenerator

  • palletdatagenerator package
    • Subpackages
      • palletdatagenerator.modes package
        • Submodules
        • Module contents
    • Submodules
      • palletdatagenerator.blender_runner module
        • BlenderEnvironmentManager
        • setup_background_images()
        • apply_random_background()
        • run_with_blender_args()
      • palletdatagenerator.cli module
        • find_blender_executable()
        • run_in_blender()
        • create_parser()
        • main()
      • palletdatagenerator.config module
        • get_next_batch_folder()
        • DefaultConfig
      • palletdatagenerator.generator module
        • ensure_dependencies()
        • PalletDataGenerator
        • enable_gpu()
        • ensure()
        • build_folders()
        • configure_render()
        • setup_compositor_nodes()
        • draw_3d_bbox_edges()
        • project_points_accurate()
        • create_analysis_image_multi()
        • main_single_pallet()
        • main_warehouse()
      • palletdatagenerator.utils module
        • setup_logging()
        • ensure_directory()
        • load_config()
        • save_config()
        • set_random_seed()
        • validate_blender_environment()
        • get_blender_version()
        • format_file_size()
        • get_system_info()
        • create_dataset_manifest()
        • verify_dataset_integrity()
        • ProgressTracker
    • Module contents
      • PalletDataGenerator
        • PalletDataGenerator.__init__()
        • PalletDataGenerator.generate()
      • DefaultConfig
        • DefaultConfig.__getattr__()
        • DefaultConfig.__init__()
        • DefaultConfig.__setattr__()
        • DefaultConfig.get()
        • DefaultConfig.update()
      • setup_logging()
Previous Next

© Copyright 2025, Ibrahim Boubakri.

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