Porcupy

Getting Started

  • Quick Start Guide
    • Your First Optimization
    • Understanding the Output
    • Visualizing the Results
    • Using GPU Acceleration
    • Next Steps
  • Installation Guide
    • Prerequisites
    • Installing Porcupy
      • Basic Installation (CPU only)
      • Installation with GPU Support
      • Development Installation
    • Verifying Installation
    • Troubleshooting
      • Common Issues
  • Configuration Guide
    • Basic Configuration
      • Algorithm Parameters
      • Defense Mechanism Parameters
    • Advanced Configuration
      • Parallel Processing
      • Custom Stopping Criteria
    • GPU Configuration
    • Environment Variables
    • Performance Tuning
      • For CPU Optimization
      • For GPU Optimization
    • Configuration Examples
      • Constrained Optimization
      • Custom Initial Population

Examples

  • Basic Optimization Examples
    • Table of Contents
    • Minimizing a Simple Function
    • Optimizing with Constraints
    • Using Different Benchmark Functions
    • Visualizing the Optimization Process
    • Saving and Loading Results
    • Real-world Example: Hyperparameter Tuning
    • Tips for Better Performance
    • Next Steps
  • Advanced Optimization Examples
    • Table of Contents
    • Multi-Objective Optimization
      • Weighted Sum Approach
      • Constraint-Based Multi-Objective
    • Dynamic Optimization
      • Time-Varying Objective
    • Hybrid Optimization
      • CPO with Local Search
    • Surrogate-Assisted Optimization
      • Using Gaussian Process Surrogate
    • Distributed Optimization
      • Parallel Evaluation with Dask
    • Custom Optimization Loop
      • Manual Iteration Control
    • Advanced Constraint Handling
      • Adaptive Constraint Handling
    • Performance Tips for Advanced Usage
  • Real-World Applications
    • Table of Contents
    • Hyperparameter Tuning for Machine Learning
      • Tuning a Random Forest Classifier
    • Neural Network Architecture Search
    • Portfolio Optimization
    • Engineering Design Optimization
      • Truss Structure Optimization
    • Supply Chain Optimization
    • Energy System Optimization
      • Microgrid Design and Operation
    • Tips for Real-World Applications

API Reference

  • Porcupy API Reference
    • Core Classes
      • Optimizer
      • CPO
    • Backend Components
      • PorcupinePopulation
      • DefenseMechanisms
      • PopulationManager
    • Population Management
      • PopulationCycle
      • SelectionStrategies
    • Visualization
      • Functions
    • Benchmark Functions
      • Unimodal Functions
      • Multimodal Functions
      • Utility Functions
    • Legacy API
      • cpo
    • Utility Modules
      • Helpers Module (porcupy.utils.helpers)
        • initialize_population(pop_size, dim, lb, ub)
        • clip_to_bounds(positions, lb, ub)
      • Plotting Module (porcupy.utils.plotting)
        • plot_convergence(cost_history, title='Convergence Curve', save_path=None)
      • Visualization Module (porcupy.utils.visualization)
        • plot_2d_search_space(func, bounds, resolution=100, positions=None, best_pos=None, save_path=None)
        • animate_optimization_2d(position_history, func, bounds, best_pos_history=None, interval=100, contour_levels=20, save_path=None, dpi=100)
      • Interactive Visualization Module (porcupy.utils.interactive_visualization)
        • OptimizationDashboard
        • ParameterTuningDashboard
      • Benchmark Functions Module (porcupy.functions)
        • Unimodal Functions
        • Multimodal Functions
        • Utility Functions
  • API Reference
    • porcupy
      • Submodules
        • porcupy.base
        • porcupy.cpo
        • porcupy.cpo_class
        • porcupy.functions
        • porcupy.gpu_cpo
        • porcupy.porcupines
        • porcupy.utils
      • Attributes
      • Package Contents
        • GPU_AVAILABLE
Porcupy
  • Search

© Copyright 2025, Samman Sarkar.

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