General Table Recognition Pipeline Tutorial¶
1. Introduction to the General Table Recognition Pipeline¶
Table recognition is a technology that automatically identifies and extracts table content and its structure from documents or images. It is widely used in data entry, information retrieval, and document analysis. By leveraging computer vision and machine learning algorithms, table recognition can convert complex table information into editable formats, facilitating further data processing and analysis for users.
The General Table Recognition Pipeline comprises modules for table structure recognition, layout analysis, text detection, and text recognition.
If you prioritize model accuracy, choose a model with higher accuracy. If you prioritize inference speed, select a model with faster inference. If you prioritize model size, choose a model with a smaller storage footprint.
👉Model List Details
Table Recognition Module Models:
Model | Model Download Link | Accuracy (%) | GPU Inference Time (ms) | CPU Inference Time (ms) | Model Size (M) | Description |
---|---|---|---|---|---|---|
SLANet | Inference Model/Trained Model | 59.52 | 522.536 | 1845.37 | 6.9 M | SLANet is a table structure recognition model developed by Baidu PaddleX Team. The model significantly improves the accuracy and inference speed of table structure recognition by adopting a CPU-friendly lightweight backbone network PP-LCNet, a high-low-level feature fusion module CSP-PAN, and a feature decoding module SLA Head that aligns structural and positional information. |
SLANet_plus | Inference Model/Trained Model | 63.69 | 522.536 | 1845.37 | 6.9 M | SLANet_plus is an enhanced version of SLANet, a table structure recognition model developed by Baidu PaddleX Team. Compared to SLANet, SLANet_plus significantly improves its recognition capabilities for wireless and complex tables, while reducing the model's sensitivity to the accuracy of table localization. Even when there are offsets in table localization, it can still perform relatively accurate recognition. |
Note: The above accuracy metrics are measured on PaddleX's internal self-built English table recognition dataset. All GPU inference times are based on an NVIDIA Tesla T4 machine with FP32 precision. CPU inference speeds are based on an Intel(R) Xeon(R) Gold 5117 CPU @ 2.00GHz with 8 threads and FP32 precision.
Layout Analysis Module Models:
Model | Model Download Link | mAP(0.5) (%) | GPU Inference Time (ms) | CPU Inference Time (ms) | Model Size (M) | Description |
---|---|---|---|---|---|---|
PicoDet_layout_1x | Inference Model/Trained Model | 86.8 | 13.0 | 91.3 | 7.4 | An efficient layout area localization model trained on the PubLayNet dataset based on PicoDet-1x can locate five types of areas, including text, titles, tables, images, and lists. |
PicoDet_layout_1x_table | Inference Model/Trained Model | 95.7 | 12.623 | 90.8934 | 7.4 M | An efficient layout area localization model trained on the PubLayNet dataset based on PicoDet-1x can locate one type of tables. |
PicoDet-S_layout_3cls | Inference Model/Trained Model | 87.1 | 13.5 | 45.8 | 4.8 | An high-efficient layout area localization model trained on a self-constructed dataset based on PicoDet-S for scenarios such as Chinese and English papers, magazines, and research reports includes three categories: tables, images, and seals. |
PicoDet-S_layout_17cls | Inference Model/Trained Model | 70.3 | 13.6 | 46.2 | 4.8 | A high-efficient layout area localization model trained on a self-constructed dataset based on PicoDet-S_layout_17cls for scenarios such as Chinese and English papers, magazines, and research reports includes 17 common layout categories, namely: paragraph titles, images, text, numbers, abstracts, content, chart titles, formulas, tables, table titles, references, document titles, footnotes, headers, algorithms, footers, and seals. |
PicoDet-L_layout_3cls | Inference Model/Trained Model | 89.3 | 15.7 | 159.8 | 22.6 | An efficient layout area localization model trained on a self-constructed dataset based on PicoDet-L for scenarios such as Chinese and English papers, magazines, and research reports includes three categories: tables, images, and seals. |
PicoDet-L_layout_17cls | Inference Model/Trained Model | 79.9 | 17.2 | 160.2 | 22.6 | A efficient layout area localization model trained on a self-constructed dataset based on PicoDet-L_layout_17cls for scenarios such as Chinese and English papers, magazines, and research reports includes 17 common layout categories, namely: paragraph titles, images, text, numbers, abstracts, content, chart titles, formulas, tables, table titles, references, document titles, footnotes, headers, algorithms, footers, and seals. |
RT-DETR-H_layout_3cls | Inference Model/Trained Model | 95.9 | 114.6 | 3832.6 | 470.1 | A high-precision layout area localization model trained on a self-constructed dataset based on RT-DETR-H for scenarios such as Chinese and English papers, magazines, and research reports includes three categories: tables, images, and seals. |
RT-DETR-H_layout_17cls | Inference Model/Trained Model | 92.6 | 115.1 | 3827.2 | 470.2 | A high-precision layout area localization model trained on a self-constructed dataset based on RT-DETR-H for scenarios such as Chinese and English papers, magazines, and research reports includes 17 common layout categories, namely: paragraph titles, images, text, numbers, abstracts, content, chart titles, formulas, tables, table titles, references, document titles, footnotes, headers, algorithms, footers, and seals. |
Note: The above accuracy metrics are evaluated on PaddleX's self-built layout analysis dataset containing 10,000 images. All GPU inference times are based on an NVIDIA Tesla T4 machine with FP32 precision. CPU inference speeds are based on an Intel(R) Xeon(R) Gold 5117 CPU @ 2.00GHz with 8 threads and FP32 precision.
Text Detection Module Models:
Model Name | Model Download Link | Detection Hmean (%) | GPU Inference Time (ms) | CPU Inference Time (ms) | Model Size (M) |
---|---|---|---|---|---|
PP-OCRv4_mobile_det | Inference Model/Trained Model | 77.79 | 10.6923 | 120.177 | 4.2 M |
PP-OCRv4_server_det | Inference Model/Trained Model | 82.69 | 83.3501 | 2434.01 | 100.1M |
2. Quick Start¶
PaddleX's pre-trained model pipelines allow for quick experience of their effects. You can experience the effects of the General Image Classification pipeline online or locally using command line or Python.
2.1 Online Experience¶
You can experience online the effects of the General Table Recognition pipeline by using the demo images provided by the official. For example:
If you are satisfied with the pipeline's performance, you can directly integrate and deploy it. If not, you can also use your private data to fine-tune the models in the pipeline online.
2.2 Local Experience¶
Before using the General Table Recognition pipeline locally, ensure you have installed the PaddleX wheel package following the PaddleX Local Installation Guide.
2.1 Command Line Experience¶
Experience the effects of the table recognition pipeline with a single command:
Experience the image anomaly detection pipeline with a single command,Use the test file, and replace --input
with the local path to perform prediction.
--pipeline: The name of the pipeline, here it's the table recognition pipeline.
--input: The local path or URL of the input image to be processed.
--device: The GPU index to use (e.g., gpu:0 for the first GPU, gpu:1,2 for the 1st and 2nd GPUs). CPU can also be selected (--device cpu).
When executing the above command, the default table recognition pipeline configuration file is loaded. If you need to customize the configuration file, you can execute the following command to obtain it:
👉Click to expand
paddlex --get_pipeline_config table_recognition
After execution, the table recognition pipeline configuration file will be saved in the current directory. If you wish to customize the save location, you can execute the following command (assuming the custom save location is ./my_path
):
paddlex --get_pipeline_config table_recognition --save_path ./my_path
After obtaining the pipeline configuration file, replace --pipeline
with the configuration file save path to make the configuration file take effect. For example, if the configuration file save path is ./table_recognition.yaml
, simply execute:
paddlex --pipeline ./table_recognition.yaml --input table_recognition.jpg --device gpu:0
Here, parameters like --model
and --device
do not need to be specified, as they will use the parameters in the configuration file. If they are still specified, the specified parameters will take precedence.
After running, the result is:
The visualized image not saved by default. You can customize the save path through --save_path
, and then all results will be saved in the specified path.
2.2 Python Script Integration¶
A few lines of code are all you need to quickly perform inference with the pipeline. Taking the General Table Recognition pipeline as an example:
from paddlex import create_pipeline
pipeline = create_pipeline(pipeline="table_recognition")
output = pipeline.predict("table_recognition.jpg")
for res in output:
res.print() # Print the structured output of the prediction
res.save_to_img("./output/") # Save the results in img format
res.save_to_xlsx("./output/") # Save the results in Excel format
res.save_to_html("./output/") # Save results in HTML format
In the above Python script, the following steps are executed:
(1)Instantiate the production line object using create_pipeline
: Specific parameter descriptions are as follows:
Parameter | Description | Type | Default |
---|---|---|---|
pipeline |
The name of the production line or the path to the production line configuration file. If it is the name of the production line, it must be supported by PaddleX. | str |
None |
device |
The device for production line model inference. Supports: "gpu", "cpu". | str |
gpu |
use_hpip |
Whether to enable high-performance inference, only available if the production line supports it. | bool |
False |
(2)Invoke the predict
method of the production line object for inference prediction: The predict
method parameter is x
, which is used to input data to be predicted, supporting multiple input methods, as shown in the following examples:
Parameter Type | Parameter Description |
---|---|
Python Var | Supports directly passing in Python variables, such as numpy.ndarray representing image data. |
str | Supports passing in the path of the file to be predicted, such as the local path of an image file: /root/data/img.jpg . |
str | Supports passing in the URL of the file to be predicted, such as the network URL of an image file: Example. |
str | Supports passing in a local directory, which should contain files to be predicted, such as the local path: /root/data/ . |
dict | Supports passing in a dictionary type, where the key needs to correspond to a specific task, such as "img" for image classification tasks. The value of the dictionary supports the above types of data, for example: {"img": "/root/data1"} . |
list | Supports passing in a list, where the list elements need to be of the above types of data, such as [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)Obtain the prediction results by calling the predict
method: The predict
method is a generator
, so prediction results need to be obtained through iteration. The predict
method predicts data in batches, so the prediction results are in the form of a list.
(4)Process the prediction results: The prediction result for each sample is of dict
type and supports printing or saving to files, with the supported file types depending on the specific pipeline. For example:
Method | Description | Method Parameters |
---|---|---|
save_to_img | Save the results as an img format file | - save_path : str, the path to save the file. When it's a directory, the saved file name will be consistent with the input file type; |
save_to_html | Save the results as an html format file | - save_path : str, the path to save the file. When it's a directory, the saved file name will be consistent with the input file type; |
save_to_xlsx | Save the results as a spreadsheet format file | - save_path : str, the path to save the file. When it's a directory, the saved file name will be consistent with the input file type; |
Where save_to_img
can save visualization results (including OCR result images, layout analysis result images, table structure recognition result images), save_to_html
can directly save the table as an html file (including text and table formatting), and save_to_xlsx
can save the table as an Excel format file (including text and formatting).
If you have a configuration file, you can customize the configurations of the image anomaly detection pipeline by simply modifying the pipeline
parameter in the create_pipeline
method to the path of the pipeline configuration file.
For example, if your configuration file is saved at ./my_path/table_recognition.yaml
, you only need to execute:
from paddlex import create_pipeline
pipeline = create_pipeline(pipeline="./my_path/table_recognition.yaml")
output = pipeline.predict("table_recognition.jpg")
for res in output:
res.print() # Print the structured output of prediction
res.save_to_img("./output/") # Save results in img format
res.save_to_xlsx("./output/") # Save results in Excel format
res.save_to_html("./output/") # Save results in HTML format
3. Development Integration/Deployment¶
If the pipeline meets your requirements for inference speed and accuracy in production, you can proceed with development integration/deployment.
If you need to directly apply the pipeline in your Python project, refer to the example code in 2.2 Python Script Integration.
Additionally, PaddleX provides three other deployment methods, detailed as follows:
🚀 High-Performance Inference: In actual production environments, many applications have stringent standards for deployment strategy performance metrics (especially response speed) to ensure efficient system operation and smooth user experience. To this end, PaddleX provides high-performance inference plugins that aim to deeply optimize model inference and pre/post-processing for significant end-to-end process acceleration. For detailed high-performance inference procedures, refer to the PaddleX High-Performance Inference Guide.
☁️ Service-Oriented Deployment: Service-oriented deployment is a common deployment form in actual production environments. By encapsulating inference functions as services, clients can access these services through network requests to obtain inference results. PaddleX supports users in achieving low-cost service-oriented deployment of pipelines. For detailed service-oriented deployment procedures, refer to the PaddleX Service-Oriented Deployment Guide.
Below are the API references and multi-language service invocation examples:
API Reference
For main operations provided by the service:
- The HTTP request method is POST.
- The request body and the response body are both JSON data (JSON objects).
- When the request is processed successfully, the response status code is
200
, and the response body properties are as follows:
Name | Type | Description |
---|---|---|
errorCode |
integer |
Error code. Fixed as 0 . |
errorMsg |
string |
Error message. Fixed as "Success" . |
The response body may also have a result
property of type object
, which stores the operation result information.
- When the request is not processed successfully, the response body properties are as follows:
Name | Type | Description |
---|---|---|
errorCode |
integer |
Error code. Same as the response status code. |
errorMsg |
string |
Error message. |
Main operations provided by the service:
infer
Locate and recognize tables in images.
POST /table-recognition
- Request body properties:
Name | Type | Description | Required |
---|---|---|---|
image |
string |
The URL of an image file accessible by the service or the Base64 encoded result of the image file content. | Yes |
inferenceParams |
object |
Inference parameters. | No |
Properties of inferenceParams
:
Name | Type | Description | Required |
---|---|---|---|
maxLongSide |
integer |
During inference, if the length of the longer side of the input image for the text detection model is greater than maxLongSide , the image will be scaled so that the length of the longer side equals maxLongSide . |
No |
- When the request is processed successfully, the
result
of the response body has the following properties:
Name | Type | Description |
---|---|---|
tables |
array |
Positions and contents of tables. |
layoutImage |
string |
Layout area detection result image. The image is in JPEG format and encoded using Base64. |
ocrImage |
string |
OCR result image. The image is in JPEG format and encoded using Base64. |
Each element in tables
is an object
with the following properties:
Name | Type | Description |
---|---|---|
bbox |
array |
Table position. The elements in the array are the x-coordinate of the top-left corner, the y-coordinate of the top-left corner, the x-coordinate of the bottom-right corner, and the y-coordinate of the bottom-right corner of the bounding box, respectively. |
html |
string |
Table recognition result in HTML format. |
Multi-Language Service Invocation Examples
Python
import base64
import requests
API_URL = "http://localhost:8080/table-recognition"
image_path = "./demo.jpg"
ocr_image_path = "./ocr.jpg"
layout_image_path = "./layout.jpg"
with open(image_path, "rb") as file:
image_bytes = file.read()
image_data = base64.b64encode(image_bytes).decode("ascii")
payload = {"image": image_data}
response = requests.post(API_URL, json=payload)
assert response.status_code == 200
result = response.json()["result"]
with open(ocr_image_path, "wb") as file:
file.write(base64.b64decode(result["ocrImage"]))
print(f"Output image saved at {ocr_image_path}")
with open(layout_image_path, "wb") as file:
file.write(base64.b64decode(result["layoutImage"]))
print(f"Output image saved at {layout_image_path}")
print("\nDetected tables:")
print(result["tables"])
C++
#include <iostream>
#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 ocrImagePath = "./ocr.jpg";
const std::string layoutImagePath = "./layout.jpg";
httplib::Headers headers = {
{"Content-Type", "application/json"}
};
std::ifstream file(imagePath, std::ios::binary | std::ios::ate);
std::streamsize size = file.tellg();
file.seekg(0, std::ios::beg);
std::vector<char> buffer(size);
if (!file.read(buffer.data(), size)) {
std::cerr << "Error reading file." << std::endl;
return 1;
}
std::string bufferStr(reinterpret_cast<const char*>(buffer.data()), buffer.size());
std::string encodedImage = base64::to_base64(bufferStr);
nlohmann::json jsonObj;
jsonObj["image"] = encodedImage;
std::string body = jsonObj.dump();
auto response = client.Post("/table-recognition", headers, body, "application/json");
if (response && response->status == 200) {
nlohmann::json jsonResponse = nlohmann::json::parse(response->body);
auto result = jsonResponse["result"];
encodedImage = result["ocrImage"];
std::string decoded_string = base64::from_base64(encodedImage);
std::vector<unsigned char> decodedOcrImage(decoded_string.begin(), decoded_string.end());
std::ofstream outputOcrFile(ocrImagePath, std::ios::binary | std::ios::out);
if (outputOcrFile.is_open()) {
outputOcrFile.write(reinterpret_cast<char*>(decodedOcrImage.data()), decodedOcrImage.size());
outputOcrFile.close();
std::cout << "Output image saved at " << ocrImagePath << std::endl;
} else {
std::cerr << "Unable to open file for writing: " << ocrImagePath << std::endl;
}
encodedImage = result["layoutImage"];
decodedString = base64::from_base64(encodedImage);
std::vector<unsigned char> decodedLayoutImage(decodedString.begin(), decodedString.end());
std::ofstream outputLayoutFile(layoutImagePath, std::ios::binary | std::ios::out);
if (outputLayoutFile.is_open()) {
outputLayoutFile.write(reinterpret_cast<char*>(decodedLayoutImage.data()), decodedlayoutImage.size());
outputLayoutFile.close();
std::cout << "Output image saved at " << layoutImagePath << std::endl;
} else {
std::cerr << "Unable to open file for writing: " << layoutImagePath << std::endl;
}
auto tables = result["tables"];
std::cout << "\nDetected tables:" << std::endl;
for (const auto& table : tables) {
std::cout << table << std::endl;
}
} else {
std::cout << "Failed to send HTTP request." << std::endl;
return 1;
}
return 0;
}
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/table-recognition";
String imagePath = "./demo.jpg";
String ocrImagePath = "./ocr.jpg";
String layoutImagePath = "./layout.jpg";
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);
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();
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 ocrBase64Image = result.get("ocrImage").asText();
String layoutBase64Image = result.get("layoutImage").asText();
JsonNode tables = result.get("tables");
byte[] imageBytes = Base64.getDecoder().decode(ocrBase64Image);
try (FileOutputStream fos = new FileOutputStream(ocrImagePath)) {
fos.write(imageBytes);
}
System.out.println("Output image saved at " + ocrBase64Image);
imageBytes = Base64.getDecoder().decode(layoutBase64Image);
try (FileOutputStream fos = new FileOutputStream(layoutImagePath)) {
fos.write(imageBytes);
}
System.out.println("Output image saved at " + layoutImagePath);
System.out.println("\nDetected tables: " + tables.toString());
} else {
System.err.println("Request failed with code: " + response.code());
}
}
}
}
Go
package main
import (
"bytes"
"encoding/base64"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
)
func main() {
API_URL := "http://localhost:8080/table-recognition"
imagePath := "./demo.jpg"
ocrImagePath := "./ocr.jpg"
layoutImagePath := "./layout.jpg"
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}
payloadBytes, err := json.Marshal(payload)
if err != nil {
fmt.Println("Error marshaling payload:", err)
return
}
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 {
OcrImage string `json:"ocrImage"`
LayoutImage string `json:"layoutImage"`
Tables []map[string]interface{} `json:"tables"`
} `json:"result"`
}
var respData Response
err = json.Unmarshal([]byte(string(body)), &respData)
if err != nil {
fmt.Println("Error unmarshaling response body:", err)
return
}
ocrImageData, err := base64.StdEncoding.DecodeString(respData.Result.OcrImage)
if err != nil {
fmt.Println("Error decoding base64 image data:", err)
return
}
err = ioutil.WriteFile(ocrImagePath, ocrImageData, 0644)
if err != nil {
fmt.Println("Error writing image to file:", err)
return
}
fmt.Printf("Image saved at %s.jpg\n", ocrImagePath)
layoutImageData, err := base64.StdEncoding.DecodeString(respData.Result.LayoutImage)
if err != nil {
fmt.Println("Error decoding base64 image data:", err)
return
}
err = ioutil.WriteFile(layoutImagePath, layoutImageData, 0644)
if err != nil {
fmt.Println("Error writing image to file:", err)
return
}
fmt.Printf("Image saved at %s.jpg\n", layoutImagePath)
fmt.Println("\nDetected tables:")
for _, table := range respData.Result.Tables {
fmt.Println(table)
}
}
C#
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/table-recognition";
static readonly string imagePath = "./demo.jpg";
static readonly string ocrImagePath = "./ocr.jpg";
static readonly string layoutImagePath = "./layout.jpg";
static async Task Main(string[] args)
{
var httpClient = new HttpClient();
byte[] imageBytes = File.ReadAllBytes(imagePath);
string image_data = Convert.ToBase64String(imageBytes);
var payload = new JObject{ { "image", image_data } };
var content = new StringContent(payload.ToString(), Encoding.UTF8, "application/json");
HttpResponseMessage response = await httpClient.PostAsync(API_URL, content);
response.EnsureSuccessStatusCode();
string responseBody = await response.Content.ReadAsStringAsync();
JObject jsonResponse = JObject.Parse(responseBody);
string ocrBase64Image = jsonResponse["result"]["ocrImage"].ToString();
byte[] ocrImageBytes = Convert.FromBase64String(ocrBase64Image);
File.WriteAllBytes(ocrImagePath, ocrImageBytes);
Console.WriteLine($"Output image saved at {ocrImagePath}");
string layoutBase64Image = jsonResponse["result"]["layoutImage"].ToString();
byte[] layoutImageBytes = Convert.FromBase64String(layoutBase64Image);
File.WriteAllBytes(layoutImagePath, layoutImageBytes);
Console.WriteLine($"Output image saved at {layoutImagePath}");
Console.WriteLine("\nDetected tables:");
Console.WriteLine(jsonResponse["result"]["tables"].ToString());
}
}
Node.js
const axios = require('axios');
const fs = require('fs');
const API_URL = 'http://localhost:8080/table-recognition'
const imagePath = './demo.jpg'
const ocrImagePath = "./ocr.jpg";
const layoutImagePath = "./layout.jpg";
let config = {
method: 'POST',
maxBodyLength: Infinity,
url: API_URL,
data: JSON.stringify({
'image': encodeImageToBase64(imagePath)
})
};
function encodeImageToBase64(filePath) {
const bitmap = fs.readFileSync(filePath);
return Buffer.from(bitmap).toString('base64');
}
axios.request(config)
.then((response) => {
const result = response.data["result"];
const imageBuffer = Buffer.from(result["ocrImage"], 'base64');
fs.writeFile(ocrImagePath, imageBuffer, (err) => {
if (err) throw err;
console.log(`Output image saved at ${ocrImagePath}`);
});
imageBuffer = Buffer.from(result["layoutImage"], 'base64');
fs.writeFile(layoutImagePath, imageBuffer, (err) => {
if (err) throw err;
console.log(`Output image saved at ${layoutImagePath}`);
});
console.log("\nDetected tables:");
console.log(result["tables"]);
})
.catch((error) => {
console.log(error);
});
PHP
<?php
$API_URL = "http://localhost:8080/table-recognition";
$image_path = "./demo.jpg";
$ocr_image_path = "./ocr.jpg";
$layout_image_path = "./layout.jpg";
$image_data = base64_encode(file_get_contents($image_path));
$payload = array("image" => $image_data);
$ch = curl_init($API_URL);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true)["result"];
file_put_contents($ocr_image_path, base64_decode($result["ocrImage"]));
echo "Output image saved at " . $ocr_image_path . "\n";
file_put_contents($layout_image_path, base64_decode($result["layoutImage"]));
echo "Output image saved at " . $layout_image_path . "\n";
echo "\nDetected tables:\n";
print_r($result["tables"]);
?>
📱 Edge Deployment: Edge deployment is a method that places computing and data processing capabilities directly on user devices, allowing devices to process data without relying on remote servers. PaddleX supports deploying models on edge devices such as Android. For detailed edge deployment procedures, refer to the PaddleX Edge Deployment Guide. Choose the appropriate deployment method for your model pipeline based on your needs, and proceed with subsequent AI application integration.
4. Custom Development¶
If the default model weights provided by the general table recognition pipeline do not meet your requirements for accuracy or speed in your specific scenario, you can try to further fine-tune the existing model using your own domain-specific or application-specific data to improve the recognition performance of the general table recognition pipeline in your scenario.
4.1 Model Fine-tuning¶
Since the general table recognition pipeline consists of four modules, unsatisfactory performance may stem from any of these modules.
Analyze images with poor recognition results and follow the rules below for analysis and model fine-tuning:
- If the detected table structure is incorrect (e.g., row and column recognition errors, incorrect cell positions), the table structure recognition module may be insufficient. You need to refer to the Customization section in the Table Structure Recognition Module Development Tutorial and use your private dataset to fine-tune the table structure recognition model.
- If the table area is incorrectly located within the overall layout, the layout detection module may be insufficient. You need to refer to the Customization section in the Layout Detection Module Development Tutorial and use your private dataset to fine-tune the layout detection model.
- If many texts are undetected (i.e., text miss detection), the text detection model may be insufficient. You need to refer to the Customization section in the Text Detection Module Development Tutorial and use your private dataset to fine-tune the text detection model.
- If many detected texts contain recognition errors (i.e., the recognized text content does not match the actual text content), the text recognition model requires further improvement. You need to refer to the Customization section.
4.2 Model Application¶
After fine-tuning your model with a private dataset, you will obtain local model weights files.
To use the fine-tuned model weights, simply modify the production line configuration file by replacing the local path of the fine-tuned model weights to the corresponding location in the configuration file:
......
Pipeline:
layout_model: PicoDet_layout_1x # Can be modified to the local path of the fine-tuned model
table_model: SLANet # Can be modified to the local path of the fine-tuned model
text_det_model: PP-OCRv4_mobile_det # Can be modified to the local path of the fine-tuned model
text_rec_model: PP-OCRv4_mobile_rec # Can be modified to the local path of the fine-tuned model
layout_batch_size: 1
text_rec_batch_size: 1
table_batch_size: 1
device: "gpu:0"
......
5. Multi-Hardware Support¶
PaddleX supports various mainstream hardware devices such as NVIDIA GPU, Kunlun XPU, Ascend NPU, and Cambricon MLU. Simply modify the --device
parameter to seamlessly switch between different hardware.
For example, if you use an NVIDIA GPU for table recognition pipeline inference, the Python command is:
At this time, if you want to switch the hardware to Ascend NPU, simply modify--device
in the Python command to npu:
If you want to use the general table recognition pipeline on more types of hardware, please refer to the PaddleX Multi-Hardware Usage Guide.