pyCombinatorial

New to Python or prefer a graphical interface? The pyCombinatorial Web App lets you run your analysis in clicks, not lines of code.

import pyCombinatorial

# Start the web service using:
pyCombinatorial.web_app()

# Terminate the web service using:
pyCombinatorial.web_stop()

• Preview -- pyCombinatorial Web App -- in Google Colab

This Google Colab Demo is intended for quick demos only. For the best experience, run the Web UI locally or open it directly in a full browser.

Introduction

pyCombinatorial is a Python-based library designed to tackle the classic Traveling Salesman Problem (TSP) through a diverse set of Exact Algorithms, Heuristics, Metaheuristics, and Reinforcement Learning. It brings together well-established and cutting-edge methodologies, offering end users a flexible toolkit to generate high-quality solutions for TSP instances of varying sizes and complexities.

Techniques: 2-opt; 2.5-opt; 3-opt; 4-opt; 5-opt; Or-opt; 2-opt Stochastic; 2.5-opt Stochastic; 3-opt Stochastic; 4-opt Stochastic; 5-opt Stochastic; Ant Colony Optimization; Adaptive Large Neighborhood Search; Bellman-Held-Karp Exact Algorithm; Bitonic Tour; Branch & Bound; BRKGA (Biased Random Key Genetic Algorithm); Brute Force; Cheapest Insertion; Christofides Algorithm; Clarke & Wright (Savings Heuristic); Concave Hull Algorithm; Convex Hull Algorithm; Elastic Net; Extremal Optimization; Farthest Insertion; FRNN (Fixed Radius Near Neighbor); Genetic Algorithm; GA-EAX (Genetic Algorithm with Edge Assembly Crossover); GRASP (Greedy Randomized Adaptive Search Procedure); Greedy Karp-Steele Patching; Guided Search; Hopfield Network; HGS (Hybrid Genetic Search); Iterated Search; Karp-Steele Patching; Large Neighborhood Search; LKH (Lin-Kernighan-Helsgaun); Multifragment Heuristic; Nearest Insertion; Nearest Neighbour; POPMUSIC (Partial OPtimization Metaheuristic Under Special Intensification Conditions); Random Insertion; Random Tour; Randomized Spectral Seriation; RL Q-Learning; RL Double Q-Learning; RL S.A.R.S.A (State Action Reward State Action); Ruin & Recreate; Scatter Search; Simulated Annealing; SOM (Self Organizing Maps); Space Filling Curve (Hilbert); Space Filling Curve (Morton); Space Filling Curve (Sierpinski); Spectral Seriation Initializer; Stochastic Hill Climbing; Sweep; Tabu Search; Truncated Branch & Bound; Twice-Around the Tree Algorithm (Double Tree Algorithm); Variable Neighborhood Search; Zero Suffix Method.

Usage

1. Install

pip install pycombinatorial

2. Import

# Required Libraries
import pandas as pd

# GA
from pyCombinatorial.algorithm import genetic_algorithm
from pyCombinatorial.utils import graphs, util

# Loading Coordinates # Berlin 52 (Minimum Distance = 7544.3659)
coordinates = pd.read_csv('https://bit.ly/3Oyn3hN', sep = '\t') 
coordinates = coordinates.values

# Obtaining the Distance Matrix
distance_matrix = util.build_distance_matrix(coordinates)

# GA - Parameters
parameters = {
            'population_size': 15,
            'elite': 1,
            'mutation_rate': 0.1,
            'mutation_search': 8,
            'generations': 1000,
            'verbose': True
             }

# GA - Algorithm
route, distance = genetic_algorithm(distance_matrix, **parameters)

# Plot Locations and Tour
graphs.plot_tour(coordinates, city_tour = route, view = 'browser', size = 10)
print('Total Distance: ', round(distance, 2))

3. Try it in Colab

3.1 Lat Long Datasets

• Lat Long ( Colab Demo )

3.2 Algorithms

• 2-opt ( Colab Demo ) ( Paper )
• 2.5-opt ( Colab Demo ) ( Paper )
• 3-opt ( Colab Demo ) ( Paper )
• 4-opt ( Colab Demo ) ( Paper )
• 5-opt ( Colab Demo ) ( Paper )
• Or-opt ( Colab Demo ) ( Paper )
• 2-opt Stochastic ( Colab Demo ) ( Paper )
• 2.5-opt Stochastic ( Colab Demo ) ( Paper )
• 3-opt Stochastic ( Colab Demo ) ( Paper )
• 4-opt Stochastic ( Colab Demo ) ( Paper )
• 5-opt Stochastic ( Colab Demo ) ( Paper )
• Ant Colony Optimization ( Colab Demo ) ( Paper )
• Adaptive Large Neighborhood Search ( Colab Demo ) ( Paper )
• Bellman-Held-Karp Exact Algorithm ( Colab Demo ) ( Paper )
• Bitonic Tour( Colab Demo ) ( Paper )
• Branch & Bound ( Colab Demo ) ( Paper )
• BRKGA (Biased Random Key Genetic Algorithm) ( Colab Demo ) ( Paper )
• Brute Force ( Colab Demo ) ( Paper )
• Cheapest Insertion ( Colab Demo ) ( Paper )
• Christofides Algorithm ( Colab Demo ) ( Paper )
• Clarke & Wright (Savings Heuristic) ( Colab Demo ) ( Paper )
• Concave Hull Algorithm ( Colab Demo ) ( Paper )
• Convex Hull Algorithm ( Colab Demo ) ( Paper )
• Elastic Net ( Colab Demo ) ( Paper )
• Extremal Optimization ( Colab Demo ) ( Paper )
• Farthest Insertion ( Colab Demo ) ( Paper )
• FRNN (Fixed Radius Near Neighbor) ( Colab Demo ) ( Paper )
• Genetic Algorithm ( Colab Demo ) ( Paper )
• Genetic Algorithm with Edge Assembly Crossover( Colab Demo ) ( Paper )
• GRASP (Greedy Randomized Adaptive Search Procedure) ( Colab Demo ) ( Paper )
• Greedy Karp-Steele Patching ( Colab Demo ) ( Paper )
• Guided Search ( Colab Demo ) ( Paper )
• Hybrid Genetic Search ( Colab Demo ) ( Paper )
• Hopfield Network ( Colab Demo ) ( Paper )
• Iterated Search ( Colab Demo ) ( Paper )
• Karp-Steele Patching ( Colab Demo ) ( Paper )
• Large Neighborhood Search ( Colab Demo ) ( Paper )
• Lin-Kernighan-Helsgaun ( Colab Demo ) ( Paper )
• Multifragment Heuristic ( Colab Demo ) ( Paper )
• Nearest Insertion ( Colab Demo ) ( Paper )
• Nearest Neighbour ( Colab Demo ) ( Paper )
• POPMUSIC ( Colab Demo ) ( Paper )
• Random Insertion ( Colab Demo ) ( Paper )
• Random Tour ( Colab Demo ) ( Paper )
• Randomized Spectral Seriation ( Colab Demo ) ( Paper )
• RL Q-Learning ( Colab Demo ) ( Paper )
• RL Double Q-Learning ( Colab Demo ) ( Paper )
• RL S.A.R.S.A ( Colab Demo ) ( Paper )
• Ruin & Recreate ( Colab Demo ) ( Paper )
• Scatter Search ( Colab Demo ) ( Paper )
• Simulated Annealing ( Colab Demo ) ( Paper )
• SOM (Self Organizing Maps) ( Colab Demo ) ( Paper )
• Space Filling Curve (Hilbert) ( Colab Demo ) ( Paper )
• Space Filling Curve (Morton) ( Colab Demo ) ( Paper )
• Space Filling Curve (Sierpinski) ( Colab Demo ) ( Paper )
• Spectral Seriation Initializer ( Colab Demo ) ( Paper )
• Stochastic Hill Climbing ( Colab Demo ) ( Paper )
• Sweep ( Colab Demo ) ( Paper )
• Tabu Search ( Colab Demo ) ( Paper )
• Truncated Branch & Bound ( Colab Demo ) ( Paper )
• Twice-Around the Tree Algorithm ( Colab Demo ) ( Paper )
• Variable Neighborhood Search ( Colab Demo ) ( Paper )
• Zero Suffix Method ( Colab Demo ) ( Paper )

Single Objective Optimization

For Single Objective Optimization, try pyMetaheuristic

Multiobjective Optimization or Many Objectives Optimization

For Multiobjective Optimization or Many Objectives Optimization, try pyMultiobjective