简体中文 | [English](image_anomaly_detection_en.md) # 图像异常检测产线使用教程 ## 1. 图像异常检测产线介绍 图像异常检测是一种通过分析图像中的内容，来识别与众不同或不符合正常模式的图像处理技术。它广泛应用于工业质量检测、医疗影像分析和安全监控等领域。通过使用机器学习和深度学习算法，图像异常检测能够自动识别出图像中潜在的缺陷、异常或异常行为，从而帮助我们及时发现问题并采取相应措施。图像异常检测系统被设计用于自动检测和标记图像中的异常情况，以提高工作效率和准确性。 ![](https://raw.githubusercontent.com/cuicheng01/PaddleX_doc_images/main/images/pipelines/image_anomaly_detection/01.png) **图像异常检测产线中包含了无监督异常检测模块，模型的benchmark如下**： |模型名称|Avg（%）|模型存储大小（M)| |-|-|-| |STFPM|96.2|21.5 M| **注：以上精度指标为 **[MVTec AD](https://www.mvtec.com/company/research/datasets/mvtec-ad)** 验证集 平均异常分数。以上所有模型 GPU 推理耗时基于 NVIDIA Tesla T4 机器，精度类型为 FP32， CPU 推理速度基于 Intel(R) Xeon(R) Gold 5117 CPU @ 2.00GHz，线程数为8，精度类型为 FP32。** ## 2. 快速开始 PaddleX 所提供的预训练的模型产线均可以快速体验效果，您可以在本地使用命令行或 Python 体验图像异常检测产线的效果。 在本地使用图像异常检测产线前，请确保您已经按照[PaddleX本地安装教程](../../../installation/installation.md)完成了PaddleX的wheel包安装。 ### 2.1 命令行方式体验 一行命令即可快速体验图像异常检测产线效果，使用 [测试文件](https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/uad_grid.png)，并将 `--input` 替换为本地路径，进行预测 ``` paddlex --pipeline anomaly_detection --input uad_grid.png --device gpu:0 ``` 参数说明： ``` --pipeline：产线名称，此处为图像异常检测产线 --input：待处理的输入图片的本地路径或URL --device 使用的GPU序号（例如gpu:0表示使用第0块GPU，gpu:1,2表示使用第1、2块GPU），也可选择使用CPU（--device cpu） ``` 在执行上述 Python 脚本时，加载的是默认的图像异常检测产线配置文件，若您需要自定义配置文件，可执行如下命令获取：
👉点击展开 ``` paddlex --get_pipeline_config anomaly_detection ``` 执行后，图像异常检测产线配置文件将被保存在当前路径。若您希望自定义保存位置，可执行如下命令（假设自定义保存位置为 ` ./my_path` ）： ``` paddlex --get_pipeline_config anomaly_detection --config_save_path ./my_path ``` 获取产线配置文件后，可将 --pipeline 替换为配置文件保存路径，即可使配置文件生效。例如，若配置文件保存路径为 `./anomaly_detection.yaml`，只需执行： ``` paddlex --pipeline ./anomaly_detection.yaml --input uad_grid.png ``` 其中，`--model`、`--device` 等参数无需指定，将使用配置文件中的参数。若依然指定了参数，将以指定的参数为准。
运行后，得到的结果为： ``` {'img_path': '/root/.paddlex/predict_input/uad_grid.png'} ``` ![](https://raw.githubusercontent.com/cuicheng01/PaddleX_doc_images/main/images/pipelines/image_anomaly_detection/02.png) 可视化图片默认保存在 `output` 目录下，您也可以通过 `--save_path` 进行自定义。 ### 2.2 Python脚本方式集成 几行代码即可完成产线的快速推理，以图像异常检测产线为例： ```python from paddlex import create_pipeline pipeline = create_pipeline(pipeline="anomaly_detection") output = pipeline.predict("uad_grid.png") for res in output: res.print() ## 打印预测的结构化输出 res.save_to_img("./output/") ## 保存结果可视化图像 res.save_to_json("./output/") ## 保存预测的结构化输出 ``` 得到的结果与命令行方式相同。 在上述 Python 脚本中，执行了如下几个步骤： （1）实例化 `create_pipeline` 实例化产线对象：具体参数说明如下： |参数|参数说明|参数类型|默认值| |-|-|-|-| |`pipeline`|产线名称或是产线配置文件路径。如为产线名称，则必须为 PaddleX 所支持的产线。|`str`|无| |`device`|产线模型推理设备。支持：“gpu”，“cpu”。|`str`|`gpu`| |`enable_hpi`|是否启用高性能推理，仅当该产线支持高性能推理时可用。|`bool`|`False`| （2）调用产线对象的 `predict` 方法进行推理预测：`predict` 方法参数为`x`，用于输入待预测数据，支持多种输入方式，具体示例如下： | 参数类型 | 参数说明 | |---------------|-----------------------------------------------------------------------------------------------------------| | Python Var | 支持直接传入Python变量，如numpy.ndarray表示的图像数据。 | | str | 支持传入待预测数据文件路径，如图像文件的本地路径：`/root/data/img.jpg`。 | | str | 支持传入待预测数据文件URL，如图像文件的网络URL：[示例](https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/uad_grid.png)。| | str | 支持传入本地目录，该目录下需包含待预测数据文件，如本地路径：`/root/data/`。 | | dict | 支持传入字典类型，字典的key需与具体任务对应，如图像分类任务对应\"img\"，字典的val支持上述类型数据，例如：`{\"img\": \"/root/data1\"}`。| | list | 支持传入列表，列表元素需为上述类型数据，如`[numpy.ndarray, numpy.ndarray]，[\"/root/data/img1.jpg\", \"/root/data/img2.jpg\"]`，`[\"/root/data1\", \"/root/data2\"]`，`[{\"img\": \"/root/data1\"}, {\"img\": \"/root/data2/img.jpg\"}]`。| （3）调用`predict`方法获取预测结果：`predict` 方法为`generator`，因此需要通过调用获得预测结果，`predict`方法以batch为单位对数据进行预测，因此预测结果为list形式表示的一组预测结果 （4）对预测结果进行处理：每个样本的预测结果均为`dict`类型，且支持打印，或保存为文件，支持保存的类型与具体产线相关，如： | 方法 | 说明 | 方法参数 | |--------------|-----------------------------|--------------------------------------------------------------------------------------------------------| | print | 打印结果到终端 | `- format_json`：bool类型，是否对输出内容进行使用json缩进格式化，默认为True；
`- indent`：int类型，json格式化设置，仅当format_json为True时有效，默认为4；
`- ensure_ascii`：bool类型，json格式化设置，仅当format_json为True时有效，默认为False； | | save_to_json | 将结果保存为json格式的文件 | `- save_path`：str类型，保存的文件路径，当为目录时，保存文件命名与输入文件类型命名一致；
`- indent`：int类型，json格式化设置，默认为4；
`- ensure_ascii`：bool类型，json格式化设置，默认为False； | | save_to_img | 将结果保存为图像格式的文件 | `- save_path`：str类型，保存的文件路径，当为目录时，保存文件命名与输入文件类型命名一致； | 若您获取了配置文件，即可对图像异常检测产线各项配置进行自定义，只需要修改 `create_pipeline` 方法中的 `pipeline` 参数值为产线配置文件路径即可。 例如，若您的配置文件保存在 `./my_path/*anomaly_detection.yaml` ，则只需执行： ```python from paddlex import create_pipeline pipeline = create_pipeline(pipeline="./my_path/anomaly_detection.yaml") output = pipeline.predict("uad_grid.png") for res in output: res.print() ## 打印预测的结构化输出 res.save_to_img("./output/") ## 保存结果可视化图像 res.save_to_json("./output/") ## 保存预测的结构化输出 ``` ## 3. 开发集成/部署 如果产线可以达到您对产线推理速度和精度的要求，您可以直接进行开发集成/部署。 若您需要将产线直接应用在您的Python项目中，可以参考 [2.2 Python脚本方式](#22-python脚本方式集成)中的示例代码。 此外，PaddleX 也提供了其他三种部署方式，详细说明如下： 🚀 **高性能部署**：在实际生产环境中，许多应用对部署策略的性能指标（尤其是响应速度）有着较严苛的标准，以确保系统的高效运行与用户体验的流畅性。为此，PaddleX 提供高性能推理插件，旨在对模型推理及前后处理进行深度性能优化，实现端到端流程的显著提速，详细的高性能部署流程请参考[PaddleX高性能部署指南](../../../pipeline_deploy/high_performance_deploy.md)。 ☁️ **服务化部署**：服务化部署是实际生产环境中常见的一种部署形式。通过将推理功能封装为服务，客户端可以通过网络请求来访问这些服务，以获取推理结果。PaddleX 支持用户以低成本实现产线的服务化部署，详细的服务化部署流程请参考[PaddleX服务化部署指南](../../../pipeline_deploy/service_deploy.md)。 下面是API参考和多语言服务调用示例：
API参考 对于服务提供的所有操作： - 响应体以及POST请求的请求体均为JSON数据（JSON对象）。 - 当请求处理成功时，响应状态码为`200`，响应体的属性如下： |名称|类型|含义| |-|-|-| |`errorCode`|`integer`|错误码。固定为`0`。| |`errorMsg`|`string`|错误说明。固定为`"Success"`。| 响应体还可能有`result`属性，类型为`object`，其中存储操作结果信息。 - 当请求处理未成功时，响应体的属性如下： |名称|类型|含义| |-|-|-| |`errorCode`|`integer`|错误码。与响应状态码相同。| |`errorMsg`|`string`|错误说明。| 服务提供的操作如下： - **`infer`** 对图像进行异常检测。 `POST /anomaly-detection` - 请求体的属性如下： |名称|类型|含义|是否必填| |-|-|-|-| |`image`|`string`|服务可访问的图像文件的URL或图像文件内容的Base64编码结果。|是| - 请求处理成功时，响应体的`result`具有如下属性： |名称|类型|含义| |-|-|-| |`labelMap`|`array`|记录图像中每个像素的类别标签（按照行优先顺序排列）。其中`255`表示异常点，`0`表示非异常点。| |`size`|`array`|图像形状。数组中元素依次为图像的高度和宽度。| |`image`|`string`|异常检测结果图。图像为JPEG格式，使用Base64编码。| `result`示例如下： ```json { "labelMap": [ 0, 0, 255, 0 ], "size": [ 2, 2 ], "image": "xxxxxx" } ```
多语言调用服务示例
Python ```python import base64 import requests API_URL = "http://localhost:8080/anomaly-detection" # 服务URL image_path = "./demo.jpg" output_image_path = "./out.jpg" # 对本地图像进行Base64编码 with open(image_path, "rb") as file: image_bytes = file.read() image_data = base64.b64encode(image_bytes).decode("ascii") payload = {"image": image_data} # Base64编码的文件内容或者图像URL # 调用API response = requests.post(API_URL, json=payload) # 处理接口返回数据 assert response.status_code == 200 result = response.json()["result"] with open(output_image_path, "wb") as file: file.write(base64.b64decode(result["image"])) print(f"Output image saved at {output_image_path}") # result.labelMap 记录图像中每个像素的类别标签（按照行优先顺序排列）详见API参考文档 ```
C++ ```cpp #include #include "cpp-httplib/httplib.h" // https://github.com/Huiyicc/cpp-httplib #include "nlohmann/json.hpp" // https://github.com/nlohmann/json #include "base64.hpp" // https://github.com/tobiaslocker/base64 int main() { httplib::Client client("localhost:8080"); const std::string imagePath = "./demo.jpg"; const std::string outputImagePath = "./out.jpg"; httplib::Headers headers = { {"Content-Type", "application/json"} }; // 对本地图像进行Base64编码 std::ifstream file(imagePath, std::ios::binary | std::ios::ate); std::streamsize size = file.tellg(); file.seekg(0, std::ios::beg); std::vector buffer(size); if (!file.read(buffer.data(), size)) { std::cerr << "Error reading file." << std::endl; return 1; } std::string bufferStr(reinterpret_cast(buffer.data()), buffer.size()); std::string encodedImage = base64::to_base64(bufferStr); nlohmann::json jsonObj; jsonObj["image"] = encodedImage; std::string body = jsonObj.dump(); // 调用API auto response = client.Post("/anomaly-detection", headers, body, "application/json"); // 处理接口返回数据 if (response && response->status == 200) { nlohmann::json jsonResponse = nlohmann::json::parse(response->body); auto result = jsonResponse["result"]; encodedImage = result["image"]; std::string decodedString = base64::from_base64(encodedImage); std::vector decodedImage(decodedString.begin(), decodedString.end()); std::ofstream outputImage(outPutImagePath, std::ios::binary | std::ios::out); if (outputImage.is_open()) { outputImage.write(reinterpret_cast(decodedImage.data()), decodedImage.size()); outputImage.close(); std::cout << "Output image saved at " << outPutImagePath << std::endl; // result.labelMap 记录图像中每个像素的类别标签（按照行优先顺序排列）详见API参考文档 } else { std::cerr << "Unable to open file for writing: " << outPutImagePath << std::endl; } } else { std::cout << "Failed to send HTTP request." << std::endl; return 1; } return 0; } ```
Java ```java import okhttp3.*; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.node.ObjectNode; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.util.Base64; public class Main { public static void main(String[] args) throws IOException { String API_URL = "http://localhost:8080/anomaly-detection"; // 服务URL String imagePath = "./demo.jpg"; // 本地图像 String outputImagePath = "./out.jpg"; // 输出图像 // 对本地图像进行Base64编码 File file = new File(imagePath); byte[] fileContent = java.nio.file.Files.readAllBytes(file.toPath()); String imageData = Base64.getEncoder().encodeToString(fileContent); ObjectMapper objectMapper = new ObjectMapper(); ObjectNode params = objectMapper.createObjectNode(); params.put("image", imageData); // Base64编码的文件内容或者图像URL // 创建 OkHttpClient 实例 OkHttpClient client = new OkHttpClient(); MediaType JSON = MediaType.Companion.get("application/json; charset=utf-8"); RequestBody body = RequestBody.Companion.create(params.toString(), JSON); Request request = new Request.Builder() .url(API_URL) .post(body) .build(); // 调用API并处理接口返回数据 try (Response response = client.newCall(request).execute()) { if (response.isSuccessful()) { String responseBody = response.body().string(); JsonNode resultNode = objectMapper.readTree(responseBody); JsonNode result = resultNode.get("result"); String base64Image = result.get("image").asText(); JsonNode labelMap = result.get("labelMap"); byte[] imageBytes = Base64.getDecoder().decode(base64Image); try (FileOutputStream fos = new FileOutputStream(outputImagePath)) { fos.write(imageBytes); } System.out.println("Output image saved at " + outputImagePath); // result.labelMap 记录图像中每个像素的类别标签（按照行优先顺序排列）详见API参考文档 } else { System.err.println("Request failed with code: " + response.code()); } } } } ```
Go ```go package main import ( "bytes" "encoding/base64" "encoding/json" "fmt" "io/ioutil" "net/http" ) func main() { API_URL := "http://localhost:8080/anomaly-detection" imagePath := "./demo.jpg" outputImagePath := "./out.jpg" // 对本地图像进行Base64编码 imageBytes, err := ioutil.ReadFile(imagePath) if err != nil { fmt.Println("Error reading image file:", err) return } imageData := base64.StdEncoding.EncodeToString(imageBytes) payload := map[string]string{"image": imageData} // Base64编码的文件内容或者图像URL payloadBytes, err := json.Marshal(payload) if err != nil { fmt.Println("Error marshaling payload:", err) return } // 调用API client := &http.Client{} req, err := http.NewRequest("POST", API_URL, bytes.NewBuffer(payloadBytes)) if err != nil { fmt.Println("Error creating request:", err) return } res, err := client.Do(req) if err != nil { fmt.Println("Error sending request:", err) return } defer res.Body.Close() // 处理接口返回数据 body, err := ioutil.ReadAll(res.Body) if err != nil { fmt.Println("Error reading response body:", err) return } type Response struct { Result struct { Image string `json:"image"` Labelmap []map[string]interface{} `json:"labelMap"` } `json:"result"` } var respData Response err = json.Unmarshal([]byte(string(body)), &respData) if err != nil { fmt.Println("Error unmarshaling response body:", err) return } outputImageData, err := base64.StdEncoding.DecodeString(respData.Result.Image) if err != nil { fmt.Println("Error decoding base64 image data:", err) return } err = ioutil.WriteFile(outputImagePath, outputImageData, 0644) if err != nil { fmt.Println("Error writing image to file:", err) return } fmt.Printf("Image saved at %s.jpg\n", outputImagePath) // result.labelMap 记录图像中每个像素的类别标签（按照行优先顺序排列）详见API参考文档 } ```
C# ```csharp using System; using System.IO; using System.Net.Http; using System.Net.Http.Headers; using System.Text; using System.Threading.Tasks; using Newtonsoft.Json.Linq; class Program { static readonly string API_URL = "http://localhost:8080/anomaly-detection"; static readonly string imagePath = "./demo.jpg"; static readonly string outputImagePath = "./out.jpg"; static async Task Main(string[] args) { var httpClient = new HttpClient(); // 对本地图像进行Base64编码 byte[] imageBytes = File.ReadAllBytes(imagePath); string image_data = Convert.ToBase64String(imageBytes); var payload = new JObject{ { "image", image_data } }; // Base64编码的文件内容或者图像URL var content = new StringContent(payload.ToString(), Encoding.UTF8, "application/json"); // 调用API HttpResponseMessage response = await httpClient.PostAsync(API_URL, content); response.EnsureSuccessStatusCode(); // 处理接口返回数据 string responseBody = await response.Content.ReadAsStringAsync(); JObject jsonResponse = JObject.Parse(responseBody); string base64Image = jsonResponse["result"]["image"].ToString(); byte[] outputImageBytes = Convert.FromBase64String(base64Image); File.WriteAllBytes(outputImagePath, outputImageBytes); Console.WriteLine($"Output image saved at {outputImagePath}"); // result.labelMap 记录图像中每个像素的类别标签（按照行优先顺序排列）详见API参考文档 } } ```
Node.js ```js const axios = require('axios'); const fs = require('fs'); const API_URL = 'http://localhost:8080/anomaly-detection' const imagePath = './demo.jpg' const outputImagePath = "./out.jpg"; let config = { method: 'POST', maxBodyLength: Infinity, url: API_URL, data: JSON.stringify({ 'image': encodeImageToBase64(imagePath) // Base64编码的文件内容或者图像URL }) }; // 对本地图像进行Base64编码 function encodeImageToBase64(filePath) { const bitmap = fs.readFileSync(filePath); return Buffer.from(bitmap).toString('base64'); } // 调用API axios.request(config) .then((response) => { // 处理接口返回数据 const result = response.data["result"]; const imageBuffer = Buffer.from(result["image"], 'base64'); fs.writeFile(outputImagePath, imageBuffer, (err) => { if (err) throw err; console.log(`Output image saved at ${outputImagePath}`); }); // result.labelMap 记录图像中每个像素的类别标签（按照行优先顺序排列）详见API参考文档 }) .catch((error) => { console.log(error); }); ```
PHP ```php $image_data); // Base64编码的文件内容或者图像URL // 调用API $ch = curl_init($API_URL); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload)); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); // 处理接口返回数据 $result = json_decode($response, true)["result"]; file_put_contents($output_image_path, base64_decode($result["image"])); echo "Output image saved at " . $output_image_path . "\n"; // result.labelMap 记录图像中每个像素的类别标签（按照行优先顺序排列）详见API参考文档 ?> ```

📱 **端侧部署**：端侧部署是一种将计算和数据处理功能放在用户设备本身上的方式，设备可以直接处理数据，而不需要依赖远程的服务器。PaddleX 支持将模型部署在 Android 等端侧设备上，详细的端侧部署流程请参考[PaddleX端侧部署指南](../../../pipeline_deploy/lite_deploy.md)。 您可以根据需要选择合适的方式部署模型产线，进而进行后续的 AI 应用集成。 ## 4. 二次开发 如果图像异常检测产线提供的默认模型权重在您的场景中，精度或速度不满意，您可以尝试利用**您自己拥有的特定领域或应用场景的数据**对现有模型进行进一步的**微调**，以提升图像异常检测产线的在您的场景中的识别效果。 ### 4.1 模型微调 由于图像异常检测产线包含无监督图像异常检测模块，如果模型产线的效果不及预期，那么您需要参考[无监督异常检测模块开发教程](../../../module_usage/tutorials/cv_modules/anomaly_detection.md)中的[二次开发](../../../module_usage/tutorials/cv_modules/anomaly_detection.md#四二次开发)章节，使用您的私有数据集对图像异常检测模型进行微调。 ### 4.2 模型应用 当您使用私有数据集完成微调训练后，可获得本地模型权重文件。 若您需要使用微调后的模型权重，只需对产线配置文件做修改，将微调后模型权重的本地路径替换至产线配置文件中的对应位置即可： ```python ...... Pipeline: model: STFPM #可修改为微调后模型的本地路径 batch_size: 1 device: "gpu:0" ...... ``` 随后， 参考本地体验中的命令行方式或 Python 脚本方式，加载修改后的产线配置文件即可。 ## 5. 多硬件支持 PaddleX 支持英伟达 GPU、昆仑芯 XPU、昇腾 NPU和寒武纪 MLU 等多种主流硬件设备，**仅需修改 `--device`** 参数即可完成不同硬件之间的无缝切换。 例如，您使用英伟达 GPU 进行图像异常检测产线的推理，使用的 Python 命令为： ``` paddlex --pipeline anomaly_detection --input uad_grid.png --device gpu:0 ``` 此时，若您想将硬件切换为昇腾 NPU，仅需对 Python 命令中的 `--device` 修改为 npu 即可： ``` paddlex --pipeline anomaly_detection --input uad_grid.png --device npu:0 ``` 若您想在更多种类的硬件上使用图像异常检测产线，请参考[PaddleX多硬件使用指南](../../../other_devices_support/installation_other_devices.md)。