defect-detection 0.4.4

API for defect detection in PCB and other components.

defect_detection

This packge provides a basic API to implement defect detection algorithms. Those can be tuned in order to automatically detect any defects in a PCB or other components.

Requirement

The following packages are required :

• numpy
• opencv-python
• torch
• scikit-learn

Recommended python version >= 3.8

Installation

To install the latest stable release from PyPI :

pip install defect_detection

For developper who wants to work with a local and editable version :

git clone https://github.com/lovaslin/defect_detection.git
cd defect_detection
pip install -e .

For the local install, you should of course run the commands using a clean python environment. I recommend to use venv to setup a pip-friendly environemnt.

Example script

An example script is available in the example/ directory of this repository.
The directory also contains all the required configuration files.

In order to run the script, you must first run the get_source_images.sh script to install the example source dataset.

cd example
./get_source_images.sh

Once the data is installed you can run the example.py script.
This script demonstrates the following features :

• Generating a augmanted dataset from source images
• Loading batches of images from disk
• Training a basic unsupervised model for defect detection
• Apply a train model to a batch of images
• Use clusturing and filtering to extract the most anomalous pixel clusters in a given image

Available features

• Dataset creation

The provided defect_detection.generate_dataset function can be used to generate a dataset suitable for training and/or testing models. A list of the source image file names must be provided together with preprocessing and data augmentation parameters.

The specification of the function arguments are available in the docstring.

• Input batch loading

A batch of images can be loaded from disk directly using the defect_detection.load_batch function. Optionally, it is possible to produce a noisy version of the input batch that can be used e.g. for training a new model. The batch of images is returned as a torch tensor stored on the required device.

If the data was already loaded as a numpy array, it is possible to convert it to a torch tensor using the defect_detection.get_tensor function. The option to generate a noisy version is also available.

• New model training

The defect_detection.deepAE_train function provides a basic training loop to train a new unsupervised defect detection model. It is recommended to use a dataset generated with the defect_detection.generate_dataset to perform the training (but not mandatory). Note that a file containing the specification of the model structure hyperparameters must be provided (see specification in wiki). The trained model will be saved on disk and the training and validation loss functions will be returned after completion of the training.

It is also possible to write a custom training loop using the built-in AE_cls.batch_train method to compute the loss and update model parameters.

• Load a existing model for application

The defect_detection.deepAE_load function allows loading a previously trained model from the disk. By default, the model will be set for application only (no training functionality available).

Once a model is loaded, it is possible to compute both the per pixel anomaly score map and loss using the built-in AE_cls.batch_apply method.