PROJECT NOT UNDER ACTIVE MANAGEMENT
This project will no longer be maintained by Intel.
Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.
Intel no longer accepts patches to this project.
If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the open source software community, please create your own fork of this project.
Contact: webadmin@linux.intel.com
The goal of this visual inspection use case is to provide AI-powered quality visual inspection on a dataset for the pharma industry which includes different data augmentations. For this purpose, a computer vision model is built using machine learning tools/libraries in Intel® oneAPI AI Analytics Toolkit. Specifically, Intel® Extension for PyTorch* is utilized to enhance performance on Intel® hardware.
Check out more workflow examples and reference implementations in the Developer Catalog.
- Solution Technical Overview
- Validated Hardware Details
- Software Requirements
- How it Works?
- Get Started
- Ways to run this reference use case
- Expected Output
- Summary and Next Steps
- Learn More
- Support
- Appendix
PyTorch* is a machine learning open source framework, and is based on the popular Torch library. PyTorch* is designed to provide good flexibility and high speeds for deep neural network implementation. PyTorch* is different from other deep learning frameworks in that it uses dynamic computation graphs. While static computational graphs (like those used in TensorFlow*) are defined prior to runtime, dynamic graphs are defined "on the fly" via the forward computation. In other words, the graph is rebuilt from scratch on every iteration.
Manual visual Inspection involves analyzing data and identifying anomalies through human observation and intuition. It can be useful in certain scenarios and also has several challenges and limitations. Some difficulties that can be found when performing manual anomaly detection are subjectivity, limited pattern recognition, lack of consistency, time and cost, and detection latency, among others.
The solution contained in this repo uses the following Intel® packages:
Intel® Distribution for Python*
The Intel® Distribution for Python* provides:
- Scalable performance using all available CPU cores on laptops, desktops, and powerful servers
- Support for the latest CPU instructions
- Near-native performance through acceleration of core numerical and machine learning packages with libraries like the Intel® oneAPI Math Kernel Library (oneMKL) and Intel® oneAPI Data Analytics Library
- Productivity tools for compiling Python code into optimized instructions
- Essential Python bindings for easing integration of Intel® native tools with your Python* project
Intel® Extension for Pytorch*
The Intel® Extension for PyTorch*:
- Extends PyTorch* with up-to-date features optimizations for an extra performance boost on Intel hardware
- Optimizations take advantage of AVX-512 Vector Neural Network Instructions (AVX512 VNNI) and Intel® Advanced Matrix Extensions (Intel® AMX) on Intel CPUs as well as Intel Xe Matrix Extensions (XMX) AI engines on Intel discrete GPUs
- Through PyTorch* xpu device, Intel® Extension for PyTorch* provides easy GPU acceleration for Intel discrete GPUs with PyTorch*
- Provides optimizations for both eager mode and graph mode
Intel® Neural Compressor*
The Intel® Neural Compressor* aims to provide popular model compression techniques such as quantization, pruning (sparsity), distillation, and neural architecture search on mainstream frameworks such as TensorFlow, PyTorch, ONNX Runtime, and MXNet, as well as Intel extensions such as Intel Extension for TensorFlow and Intel Extension for PyTorch.
For more details, visit Quality Visual Inspection GitHub repository.
This sample code is implemented for CPU using the Python language and Intel® Extension for PyTorch* v1.13.120 has been used in this code base. VGGNet, a classical convolutional neural network (CNN) architecture is being used for training. The Visual Geometric Group model (VGG) was developed to increase the depth of such CNNs in order to increase the model performance and it is widely used in computer vision use cases. Tuning parameters has been introduced to the model in an optimization algorithm with different learning rate for checking how quickly the model is adapted to the problem in order to increase the model performance.
MVTec AD [1] is a dataset for benchmarking anomaly detection methods with a focus on industrial inspection (follow this link to read the legal disclaimer). It contains over 5000 high-resolution images divided into fifteen different object and texture categories. Each category comprises a set of defect-free training images and a test set of images with various kinds of defects as well as images without defects. We are going to use only the Pill (262 MB) dataset for this use case.
More information can be found on the case study Explainable Defect Detection Using Convolutional Neural Networks: Case Study [2] and in VGG16 Model Training [3].
Table 1: Statistical overview of the MVTec AD dataset. For each category, the number of training and test images is given together with additional information about the defects present in the respective test images [4].
There are workflow-specific hardware and software setup requirements.
| Recommended Hardware | Precision |
|---|---|
| CPU: Intel® 2nd Gen Xeon® Platinum 8280 CPU @ 2.70GHz or higher | FP32, INT8 |
| RAM: 187 GB | |
| Recommended Free Disk Space: 20 GB or more |
Code was tested on Ubuntu* 22.04 LTS.
This reference use case uses a classical convolutional neural network (CNN) architecture, named VGGNet, implemented for CPU using the Python language and Intel® Extension for PyTorch*. VGG was developed to increase the depth of such CNNs in order to increase the model performance and it is widely used in computer vision use cases.
The use case can be summarized in three steps:
- Training
- Tunning
- Inference
VGG-16 is a convolutional neural network that is 16 layers deep and same has been used as classification architecture to classify the good and defect samples from the production pipeline. Intel® Extension for PyTorch* is used for transfer learning the VGGNet classification architecture on the pill dataset created.
| Input Size | 224x224 |
|---|---|
| Output Model format | PyTorch* |
Created VGGNet classification architecture on the dataset and fine tune the hyper parameters to reach out the maximum accuracy. Introduced different learning rate to the model architecture on the dataset, also we increased the number of epochs to reach maximum accuracy on the training set. Hyperparameters considered for tuning are Learning Rate & Epochs.
Parameters considered Learning Rate, Epochs, Target training accuracy
Created code replication for GridSearchCV to support the code base.
Performed inferencing using the trained model with
- Intel® Extension for PyTorch*
- Intel® Neural Compressor
Define an environment variable that will store the workspace path, this can be an existing directory or one created specifically for this reference use case. You can use the following commands.
export WORKSPACE=$PWD/visual-quality-inspection
export DATA_DIR=$WORKSPACE/data
export OUTPUT_DIR=$WORKSPACE/output
Create a working directory for the workflow and clone the Quality Visual Inspection repository into your working directory.
mkdir -p $WORKSPACE && cd $WORKSPACE
git clone https://github.com/oneapi-src/visual-quality-inspection.git .
-
Download the appropriate Miniconda Installer for linux.
wget -q https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
-
In your terminal, run.
bash Miniconda3-latest-Linux-x86_64.sh
-
Delete downloaded file.
rm Miniconda3-latest-Linux-x86_64.sh
To learn more about conda installation, see the Conda Linux installation instructions.
The conda yaml dependencies are kept in $WORKSPACE/env/intel_env.yml.
| Packages required in YAML file: | Version: |
|---|---|
python |
3.9 |
intel-aikit-pytorch |
2024.0 |
scikit-learn-intelex |
2024.0.0 |
seaborn |
0.13.0 |
dataset_librarian |
1.0.4 |
Follow the next steps to setup the conda environment:
conda config --set solver libmamba # If conda<2.10.0
conda env create -f $WORKSPACE/env/intel_env.yml --no-default-packages
conda activate visual_inspection_intelEnvironment setup is required only once. This step does not cleanup the existing environment with the same name hence we need to make sure there is no conda environment exists with the same name. During this setup, visual_inspection_intel conda environment will be created with the dependencies listed in the YAML configuration.
The pill dataset is downloaded and extracted in a folder before running the training python module.
Download the mvtec dataset using Intel® AI Reference Models Dataset Librarian (You can get the Dataset from MVTec AD [1]). We are going to use the pill dataset.
More details of the Intel® AI Reference Models Dataset Librarian can be found here and, terms and conditions can be found here.
python -m dataset_librarian.dataset -n mvtec-ad --download --preprocess -d $DATA_DIRNote: See this dataset's applicable license for terms and conditions. Intel Corporation does not own the rights to this dataset and does not confer any rights to it.
The dataset available from the source requires a filtering before the training. Assuming the pill dataset is downloaded with the Intel® AI Reference Models Dataset Librarian or using from the dataset source given above in this document, follow the below steps to filter the dataset extracted from the source.
mkdir -p $DATA_DIR/{train/{good,bad},test/{good,bad}}
cd $DATA_DIR/pill/train/good/
cp $(ls | head -n 210) $DATA_DIR/train/good/
cp $(ls | tail -n 65) $DATA_DIR/test/good/
cd $DATA_DIR/pill/test/combined
cp $(ls | head -n 17) $DATA_DIR/train/bad/
cp $(ls | tail -n 5) $DATA_DIR/test/bad/Data Cloning
Note Data cloning is an optional step
Assuming that pill dataset is downloaded and created the folder structure as mentioned above. Use the below code to clone the data to handle data distribution. Data will be cloned in same directory (e.g. "data")
usage: clone_dataset.py [-h] [-d DATAPATH]
optional arguments:
-h, --help show this help message and exit
-d DATAPATH, --datapath DATAPATH
dataset path which consists of train and test folders
Use the below sample command to perform data cloning
cd $WORKSPACE/src
python clone_dataset.py -d $DATA_DIRThis reference kit offers one options for running the fine-tuning and inference processes:
Note: The performance were tested on Xeon based processors. Some portions of the ref kits may run slower on a client machine, so utilize the flags supported to modify the epochs/batch size to run the training or inference faster.
Note: Follow these instructions to set up and run this workflow on your own development system.
Below are the steps to reproduce the bechmarking results given in this repository
- Training VGG16 model
- Model Inference
- Quantize trained models using INC and benchmarking
Run the training module as given below to start training and prediction using the active environment. This module takes option to run the training with and without hyper parameter tuning.
usage: training.py [-h] [-d DATAPATH] [-o OUTMODEL] [-a DATAAUG] [-hy HYPERPARAMS]
optional arguments:
-h, --help show this help message and exit
-d DATAPATH, --datapath DATAPATH
dataset path which consists of train and test folders
-o OUTMODEL, --outmodel OUTMODEL
outfile name without extension to save the model.
-a DATAAUG, --dataaug DATAAUG
use 1 for enabling data augmentation, default is 0
-hy HYPERPARAMS, --hyperparams HYPERPARAMS
use 1 for enabling hyperparameter tuning, default is 0
You need to change directory to src folder
cd $WORKSPACE/srcCommand to run training without data augmentation nor hyperparameter tuning
python training.py -d $DATA_DIR -o $OUTPUT_DIR/pill_intel_model.h5The model is saved in the OUTPUT_DIR as pill_intel.h5.
Command to run training with data augmentation
python training.py -d $DATA_DIR -a 1 -o $OUTPUT_DIR/pill_intel_model.h5Command to run training with hyperparameter tuning
python training.py -d $DATA_DIR -hy 1 -o $OUTPUT_DIR/pill_intel_model.h5Command to run training with data augmentation and hyperparameter tuning
python training.py -d $DATA_DIR -a 1 -hy 1 -o $OUTPUT_DIR/pill_intel_model.h5Use the following commands to run the inference on test images and get the inference timing for each batch of images.
usage: pytorch_evaluation.py [-h] [-d DATA_FOLDER] [-m MODEL_PATH] [-b BATCHSIZE]
optional arguments:
-h, --help show this help message and exit
-d DATA_FOLDER, --data_folder DATA_FOLDER
dataset path which consists of train and test folders
-m MODEL_PATH, --model_path MODEL_PATH
Absolute path to the h5 PyTorch* model with extension ".h5"
-b BATCHSIZE, --batchsize BATCHSIZE
use the batchsize that want do inference, default is 1
You need to activate visual_inspection_intel environment and change directory to src folder
cd $WORKSPACE/srcCommand to run the real-time inference using Intel® PyTorch*
python pytorch_evaluation.py -d $DATA_DIR -m $OUTPUT_DIR/{trained_model.h5} -b 1Using model from previous steps:
python pytorch_evaluation.py -d $DATA_DIR -m $OUTPUT_DIR/pill_intel_model.h5 -b 1By using different batchsize one can observe the gain obtained using Intel® Extension for PyTorch*
Intel® Neural Compressor is used to quantize the FP32 Model to the INT8 Model. Optimized model is used here for evaluating and timing analysis.
Intel® Neural Compressor supports many optimization methods. In this case, we used post training quantization with Accuracy aware mode method to quantize the FP32 model.
Step-1: Conversion of FP32 Model to INT8 Model
usage: neural_compressor_conversion.py [-h] [-d DATAPATH] [-m MODELPATH]
[-c CONFIG] [-o OUTPATH]
optional arguments:
-h, --help show this help message and exit
-d DATAPATH, --datapath DATAPATH
dataset path which consists of train and test folders
-m MODELPATH, --modelpath MODELPATH
Model path trained with PyTorch* ".h5" file
-c CONFIG, --config CONFIG
Yaml file for quantizing model, default is
"./config.yaml"
-o OUTPATH, --outpath OUTPATH
default output quantized model will be save in
./output folder
Command to run the neural_compressor_conversion
cd $WORKSPACE/src/intel_neural_compressor
python neural_compressor_conversion.py -d $DATA_DIR -m $OUTPUT_DIR/{trained_model.h5} -o $OUTPUT_DIRUsing model from previous steps:
cd $WORKSPACE/src/intel_neural_compressor
python neural_compressor_conversion.py -d $DATA_DIR -m $OUTPUT_DIR/pill_intel_model.h5 -o $OUTPUT_DIRQuantized model will be saved by default in
OUTPUT_DIRfolder
Step-2: Inferencing using quantized Model
usage: neural_compressor_inference.py [-h] [-d DATAPATH] [-fp32 FP32MODELPATH]
[-c CONFIG] [-int8 INT8MODELPATH]
optional arguments:
-h, --help show this help message and exit
-d DATAPATH, --datapath DATAPATH
dataset path which consists of train and test folders
-fp32 FP32MODELPATH, --fp32modelpath FP32MODELPATH
Model path trained with PyTorch* ".h5" file
-c CONFIG, --config CONFIG
Yaml file for quantizing model, default is
"./config.yaml"
-int8 INT8MODELPATH, --int8modelpath INT8MODELPATH
load the quantized model folder. default is ./output
folder
Command to run neural_compressor_inference for realtime (batchsize =1)
cd $WORKSPACE/src/intel_neural_compressor
python neural_compressor_inference.py -d $DATA_DIR -fp32 $OUTPUT_DIR/{trained_model.h5} -int8 $OUTPUT_DIR -b 1Using model from previous steps:
cd $WORKSPACE/src/intel_neural_compressor
python neural_compressor_inference.py -d $DATA_DIR -fp32 $OUTPUT_DIR/pill_intel_model.h5 -int8 $OUTPUT_DIR -b 1Use
-bto test with different batch size (e.g.-b 10)
Follow these steps to restore your $WORKSPACE directory to an initial step. Please note that all downloaded dataset files, conda environment, and logs created by workflow will be deleted. Before executing next steps back up your important files.
conda deactivate
conda env remove -n visual_inspection_intel
rm -rf $DATA_DIR/*
rm -rf $OUTPUT_DIR/*Remove repository
rm -rf $WORKSPACEBelow output would be generated by the training module which will capture the overall training time.
Dataset path Found!!
Train and Test Data folders Found!
Dataset data/: N Images = 694, Share of anomalies = 0.218
Epoch 1/10: Loss = 0.6575, Accuracy = 0.7236
Epoch 2/10: Loss = 0.4175, Accuracy = 0.8455
Epoch 3/10: Loss = 0.3731, Accuracy = 0.8691
Epoch 4/10: Loss = 0.2419, Accuracy = 0.9273
Epoch 5/10: Loss = 0.0951, Accuracy = 0.9745
Epoch 6/10: Loss = 0.0796, Accuracy = 0.9709
Epoch 7/10: Loss = 0.0696, Accuracy = 0.9764
Epoch 8/10: Loss = 0.0977, Accuracy = 0.9727
Epoch 9/10: Loss = 0.0957, Accuracy = 0.9727
Epoch 10/10: Loss = 0.1580, Accuracy = 0.9600
train_time= 1094.215266942978
Capturing the time for training and inferencing
The line containing train_time gives the time required for the training the model.
Run this script to record multiple trials and the average can be calculated.
Below output would be generated by the Inferencing using quantized Model with neural compressor.
Batch Size used here is 1
Average Inference Time Taken Fp32 --> 0.035616397857666016
Average Inference Time Taken Int8 --> 0.011458873748779297
**************************************************
Evaluating the Quantizaed Model
**************************************************
2023-07-04 05:59:42 [WARNING] Force convert framework model to neural_compressor model.
2023-07-04 05:59:42 [INFO] Start to run Benchmark.
2023-07-04 05:59:49 [INFO]
accuracy mode benchmark result:
2023-07-04 05:59:49 [INFO] Batch size = 1
2023-07-04 05:59:49 [INFO] Accuracy is 0.9595
**************************************************
Evaluating the FP32 Model
**************************************************
2023-07-04 05:59:49 [WARNING] Force convert framework model to neural_compressor model.
2023-07-04 05:59:49 [INFO] Start to run Benchmark.
2023-07-04 05:59:59 [INFO]
accuracy mode benchmark result:
2023-07-04 05:59:59 [INFO] Batch size = 1
2023-07-04 05:59:59 [INFO] Accuracy is 0.9595
Intel® Extension for PyTorch* v2.0.110
- The reference use case above demonstrates an Anomaly Detection approach using a convolutional neural network. For optimal performance on Intel architecture, the scripts are also enabled with Intel extension for PyTorch*, Intel extension for scikit-learn and Intel® Neural Compressor.
This reference use case can be easily deployed on a different or customized dataset by simply arranging the images for training and testing in the following folder structure (Note: this approach only uses good images for training):
With the arrival of computer vision (CV) techniques, powered by Artificial Intelligence (AI) and deep learning, visual inspection has been digitalized and automated. Factories have installed cameras in each production line and huge quantities of images are read and processed using a deep learning model trained for defect detection. If each production line will have its CV application running on the edge to train that can show the scale of the challenge this industry faces with automation. CV applications demand, however, huge amounts of processing power to process the increasing image load, requiring a trade-off between accuracy, inference performance, and compute cost. Manufacturers will look for easy and cost-effective ways to deploy computer vision applications across edge-cloud infrastructures to balance the cost without impacting accuracy and inference performance. This reference kit implementation provides performance-optimized guide around quality visual inspection use cases that can be easily scaled across similar use cases.
For more information about or to read about other relevant workflow examples, see these guides and software resources:
- Intel® AI Analytics Toolkit (AI Kit)
- Developer Catalog
- Intel® Distribution for Python*
- Intel® Extension for PyTorch*
- Intel® Neural Compressor*
If you have any questions with this workflow, want help with troubleshooting, want to report a bug or submit enhancement requests, please submit a GitHub issue.
[1] GmbH, M. (2023). MVTec Anomaly Detection Dataset: MVTec Software. Retrieved 5 September 2023, from https://www.mvtec.com/company/research/datasets/mvtec-ad
[2] Explainable Defect Detection Using Convolutional Neural Networks: Case Study. (2022). Retrieved 5 September 2023, from https://towardsdatascience.com/explainable-defect-detection-using-convolutional-neural-networks-case-study-284e57337b59
[3] GitHub - OlgaChernytska/Visual-Inspection: Explainable Defect Detection using Convolutional Neural Networks: Case Study. (2023). Retrieved 5 September 2023, from https://github.com/OlgaChernytska/Visual-Inspection
[4] Bergmann, P., Fauser, M., Sattlegger, D., & Steger, C. (2019). MVTec AD--A comprehensive real-world dataset for unsupervised anomaly detection. In Proceedings of the IEEE/CVF conference on computer vision and pattern recognition (pp. 9592-9600).
To the extent that any public or non-Intel datasets or models are referenced by or accessed using tools or code on this site those datasets or models are provided by the third party indicated as the content source. Intel does not create the content and does not warrant its accuracy or quality. By accessing the public content, or using materials trained on or with such content, you agree to the terms associated with that content and that your use complies with the applicable license.
Intel expressly disclaims the accuracy, adequacy, or completeness of any such public content, and is not liable for any errors, omissions, or defects in the content, or for any reliance on the content. Intel is not liable for any liability or damages relating to your use of public content.
Please see this data set's applicable license for terms and conditions. Intel®Corporation does not own the rights to this data set and does not confer any rights to it.
*Other names and brands that may be claimed as the property of others. Trademarks.
Performance varies by use, configuration, and other factors. Learn more on the Performance Index site.
Performance results are based on testing as of dates shown in configurations and may not reflect all publicly available updates. See backup for configuration details. No product or component can be absolutely secure. Your costs and results may vary.
Intel technologies may require enabled hardware, software, or service activation.
© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.