Pedestrian Attribute Recognition Module Development Tutorial¶
I. Overview¶
Pedestrian attribute recognition is a crucial component in computer vision systems, responsible for locating and labeling specific attributes of pedestrians in images or videos, such as gender, age, clothing color, and type. The performance of this module directly impacts the accuracy and efficiency of the entire computer vision system. The pedestrian attribute recognition module typically outputs attribute information for each pedestrian, which is then passed as input to other modules (e.g., pedestrian tracking, pedestrian re-identification) for subsequent processing.
II. Supported Model List¶
Model | Model Download Link | mA (%) | GPU Inference Time (ms) [Normal Mode / High-Performance Mode] |
CPU Inference Time (ms) [Normal Mode / High-Performance Mode] |
Model Size (M) | Description |
---|---|---|---|---|---|---|
PP-LCNet_x1_0_pedestrian_attribute | Inference Model/Trained Model | 92.2 | 2.35 / 0.49 | 3.17 / 1.25 | 6.7 M | PP-LCNet_x1_0_pedestrian_attribute is a lightweight pedestrian attribute recognition model based on PP-LCNet, covering 26 categories |
Test Environment Description:
- Performance Test Environment
- Test Dataset: PaddleX's internal self-built dataset.
-
Hardware Configuration:
- GPU: NVIDIA Tesla T4
- CPU: Intel Xeon Gold 6271C @ 2.60GHz
- Other Environments: Ubuntu 20.04 / cuDNN 8.6 / TensorRT 8.5.2.2
-
Inference Mode Description
Mode | GPU Configuration | CPU Configuration | Acceleration Technology Combination |
---|---|---|---|
Normal Mode | FP32 Precision / No TRT Acceleration | FP32 Precision / 8 Threads | PaddleInference |
High-Performance Mode | Optimal combination of pre-selected precision types and acceleration strategies | FP32 Precision / 8 Threads | Pre-selected optimal backend (Paddle/OpenVINO/TRT, etc.) |
III. Quick Integration¶
❗ Before quick integration, please install the PaddleX wheel package. For detailed instructions, refer to the PaddleX Local Installation Guide
After installing the wheel package, a few lines of code can complete the inference of the pedestrian attribute recognition module. You can easily switch models under this module and integrate the model inference of pedestrian attribute recognition into your project. Before running the following code, please download the demo image to your local machine.
from paddlex import create_model
model = create_model(model_name="PP-LCNet_x1_0_pedestrian_attribute")
output = model.predict("pedestrian_attribute_006.jpg", batch_size=1)
for res in output:
res.print(json_format=False)
res.save_to_img("./output/")
res.save_to_json("./output/res.json")
After running, the obtained result is:
{'res': {'input_path': 'pedestrian_attribute_006.jpg', 'page_index': None, 'class_ids': array([10, ..., 23]), 'scores': array([1. , ..., 0.54777]), 'label_names': ['LongCoat(长外套)', 'Age18-60(年龄在18-60岁之间)', 'Trousers(长裤)', 'Front(面朝前)']}}
Note: The index of the class_ids
value represents the following attributes: index 0 indicates whether a hat is worn, index 1 indicates whether glasses are worn, indexes 2-7 represent the style of the upper garment, indexes 8-13 represent the style of the lower garment, index 14 indicates whether boots are worn, indexes 15-17 represent the type of bag carried, index 18 indicates whether an object is held in front, indexes 19-21 represent age, index 22 represents gender, and indexes 23-25 represent orientation. Specifically, the attributes include the following types:
- Gender: Male, Female
- Age: Under 18, 18-60, Over 60
- Orientation: Front, Back, Side
- Accessories: Glasses, Hat, None
- Holding Object in Front: Yes, No
- Bag: Backpack, Shoulder Bag, Handbag
- Upper Garment Style: Striped, Logo, Plaid, Patchwork
- Lower Garment Style: Striped, Patterned
- Short-sleeved Shirt: Yes, No
- Long-sleeved Shirt: Yes, No
- Long Coat: Yes, No
- Pants: Yes, No
- Shorts: Yes, No
- Skirt: Yes, No
- Boots: Yes, No
The meanings of the parameters in the running result are as follows:
- input_path
: Indicates the path of the input multi-category image to be predicted.
- page_index
: If the input is a PDF file, it indicates which page of the PDF is currently being processed; otherwise, it is None
.
- class_ids
: Indicates the predicted label IDs of the pedestrian attribute images.
- scores
: Indicates the confidence scores of the predicted labels of the pedestrian attribute images.
- label_names
: Indicates the names of the predicted labels of the pedestrian attribute images.
The visualization image is as follows:
Relevant methods, parameters, and explanations are as follows:
create_model
instantiates the vehicle attribute recognition model (here,PP-LCNet_x1_0_pedestrian_attribute
is used as an example). The specific explanations are as follows:
Parameter | Parameter Description | Parameter Type | Options | Default Value |
---|---|---|---|---|
model_name |
The name of the model | str |
None | PP-LCNet_x1_0_pedestrian_attribute |
model_dir |
The storage path of the model | str |
None | None |
threshold |
The threshold for vehicle attribute recognition | float/list/dict |
0.5 [0.5,0.5,...] {"default":0.5,1:0.1,...} |
0.5 |
-
The
model_name
must be specified. After specifyingmodel_name
, PaddleX's built-in model parameters are used by default. Ifmodel_dir
is specified, the user-defined model is used. -
The
threshold
parameter is used to set the threshold for multi-label classification, with a default value of 0.7. When set as a float, it means all categories use this threshold; when set as a list, different categories use different thresholds, and the list length must match the number of categories; when set as a dictionary, "default" is a required key, indicating the default threshold for all categories, while other categories use their respective thresholds. For example:{"default":0.5,1:0.1}
. -
The
predict()
method of the multi-label classification model is called for inference prediction. The parameters of thepredict()
method includeinput
,batch_size
, andthreshold
, with specific explanations as follows:
Parameter | Parameter Description | Parameter Type | Optional | Default Value |
---|---|---|---|---|
input |
Data to be predicted, supporting multiple input types | Python Var /str /list |
|
None |
batch_size |
Batch size | int |
Any integer | 1 |
threshold |
Threshold for pedestrian attribute recognition | float/list/dict |
|
0.5 |
- Process the prediction results. Each sample's prediction result is a corresponding Result object, and it supports operations such as printing, saving as an image, and saving as a
json
file:
Method | Method Description | Parameter | Parameter Type | Parameter Description | Default Value |
---|---|---|---|---|---|
print() |
Print the result to the terminal | format_json |
bool |
Whether to format the output content using JSON indentation |
True |
indent |
int |
Specify the indentation level to beautify the output JSON data, making it more readable, only effective when format_json is True |
4 | ||
ensure_ascii |
bool |
Control whether to escape non-ASCII characters to Unicode . When set to True , all non-ASCII characters will be escaped; False retains the original characters, only effective when format_json is True |
False |
||
save_to_json() |
Save the result as a JSON file | save_path |
str |
The file path to save the result. When it is a directory, the saved file name will be consistent with the input file name | None |
indent |
int |
Specify the indentation level to beautify the output JSON data, making it more readable, only effective when format_json is True |
4 | ||
ensure_ascii |
bool |
Control whether to escape non-ASCII characters to Unicode . When set to True , all non-ASCII characters will be escaped; False retains the original characters, only effective when format_json is True |
False |
||
save_to_img() |
Save the result as an image file | save_path |
str |
The file path to save the result. When it is a directory, the saved file name will be consistent with the input file name | None |
- Additionally, it also supports obtaining the visualized image with results and the prediction results through attributes, as follows:
Attribute | Attribute Description |
---|---|
json |
Get the prediction result in json format |
img |
Get the visualized image in dict format |
For more information on the usage of PaddleX single-model inference APIs, you can refer to the PaddleX Single-Model Python Script Usage Instructions.
IV. Custom Development¶
If you seek higher accuracy from existing models, you can leverage PaddleX's custom development capabilities to develop better pedestrian attribute recognition models. Before developing pedestrian attribute recognition with PaddleX, ensure you have installed the classification-related model training plugins for PaddleX. The installation process can be found in the custom development section of the PaddleX Local Installation Guide.
4.1 Data Preparation¶
Before model training, you need to prepare a dataset for the specific task module. PaddleX provides data validation functionality for each module, and only data that passes validation can be used for model training. Additionally, PaddleX provides demo datasets for each module, which you can use to complete subsequent development. If you wish to use a private dataset for model training, refer to the PaddleX Multi-Label Classification Task Module Data Annotation Tutorial.
4.1.1 Demo Data Download¶
You can use the following commands to download the demo dataset to a specified folder:
wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/pedestrian_attribute_examples.tar -P ./dataset
tar -xf ./dataset/pedestrian_attribute_examples.tar -C ./dataset/
4.1.2 Data Validation¶
Run a single command to complete data validation:
python main.py -c paddlex/configs/modules/pedestrian_attribute_recognition/PP-LCNet_x1_0_pedestrian_attribute.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/pedestrian_attribute_examples
Check dataset passed !
in the log. The validation results file is saved in ./output/check_dataset_result.json
, and related outputs are saved in the ./output/check_dataset
directory in the current directory, including visual examples of sample images and sample distribution histograms.
👉 Details of Validation Results (Click to Expand)
The specific content of the validation result file is:
{
"done_flag": true,
"check_pass": true,
"attributes": {
"label_file": "../../dataset/pedestrian_attribute_examples/label.txt",
"num_classes": 26,
"train_samples": 1000,
"train_sample_paths": [
"check_dataset/demo_img/020907.jpg",
"check_dataset/demo_img/004274.jpg",
"check_dataset/demo_img/009412.jpg",
"check_dataset/demo_img/026873.jpg",
"check_dataset/demo_img/030560.jpg",
"check_dataset/demo_img/022846.jpg",
"check_dataset/demo_img/009055.jpg",
"check_dataset/demo_img/015399.jpg",
"check_dataset/demo_img/006435.jpg",
"check_dataset/demo_img/055307.jpg"
],
"val_samples": 500,
"val_sample_paths": [
"check_dataset/demo_img/080381.jpg",
"check_dataset/demo_img/080469.jpg",
"check_dataset/demo_img/080146.jpg",
"check_dataset/demo_img/080003.jpg",
"check_dataset/demo_img/080283.jpg",
"check_dataset/demo_img/080104.jpg",
"check_dataset/demo_img/080149.jpg",
"check_dataset/demo_img/080313.jpg",
"check_dataset/demo_img/080131.jpg",
"check_dataset/demo_img/080412.jpg"
]
},
"analysis": {
"histogram": "check_dataset/histogram.png"
},
"dataset_path": "pedestrian_attribute_examples",
"show_type": "image",
"dataset_type": "MLClsDataset"
}
In the above validation results, check_pass
being True indicates that the dataset format meets the requirements. Explanations for other indicators are as follows:
attributes.num_classes
: The number of classes in this dataset is 26;attributes.train_samples
: The number of samples in the training set of this dataset is 1000;attributes.val_samples
: The number of samples in the validation set of this dataset is 500;attributes.train_sample_paths
: The list of relative paths to the visualization images of samples in the training set of this dataset;attributes.val_sample_paths
: The list of relative paths to the visualization images of samples in the validation set of this dataset;
Additionally, the dataset verification also analyzes the distribution of the length and width of all images in the dataset and plots a histogram (histogram.png):
4.1.3 Dataset Format Conversion/Dataset Splitting (Optional)¶
After completing data validation, you can convert the dataset format or re-split the training/validation ratio of the dataset by modifying the configuration file or appending hyperparameters.
👉 Dataset Format Conversion/Dataset Splitting Details (Click to Expand)
(1) Dataset Format Conversion
Pedestrian attribute recognition does not support data format conversion.
(2) Dataset Splitting
The dataset splitting parameters can be set by modifying the fields under CheckDataset
in the configuration file. An example of part of the configuration file is shown below:
CheckDataset
:split
:enable
: Whether to re-split the dataset. Set toTrue
to enable dataset splitting, default isFalse
;train_percent
: If re-splitting the dataset, set the percentage of the training set. The type is any integer between 0-100, ensuring the sum withval_percent
is 100;
For example, if you want to re-split the dataset with a 90% training set and a 10% validation set, modify the configuration file as follows:
......
CheckDataset:
......
split:
enable: True
train_percent: 90
val_percent: 10
......
Then execute the command:
python main.py -c paddlex/configs/modules/pedestrian_attribute_recognition/PP-LCNet_x1_0_pedestrian_attribute.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/pedestrian_attribute_examples
After the data splitting is executed, the original annotation files will be renamed to xxx.bak
in the original path.
The above parameters also support being set by appending command-line arguments:
python main.py -c paddlex/configs/modules/pedestrian_attribute_recognition/PP-LCNet_x1_0_pedestrian_attribute.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/pedestrian_attribute_examples \
-o CheckDataset.split.enable=True \
-o CheckDataset.split.train_percent=90 \
-o CheckDataset.split.val_percent=10
4.2 Model Training¶
Model training can be completed with a single command. Taking the training of the PP-LCNet pedestrian attribute recognition model (PP-LCNet_x1_0_pedestrian_attribute) as an example:
python main.py -c paddlex/configs/modules/pedestrian_attribute_recognition/PP-LCNet_x1_0_pedestrian_attribute.yaml \
-o Global.mode=train \
-o Global.dataset_dir=./dataset/pedestrian_attribute_examples
- Specify the path of the model's
.yaml
configuration file (here it isPP-LCNet_x1_0_pedestrian_attribute.yaml
,When training other models, you need to specify the corresponding configuration files. The relationship between the model and configuration files can be found in the PaddleX Model List (CPU/GPU)) - Specify the mode as model training:
-o Global.mode=train
- Specify the path of the training dataset:
-o Global.dataset_dir
. Other related parameters can be set by modifying the fields underGlobal
andTrain
in the.yaml
configuration file, or adjusted by appending parameters in the command line. For example, to specify training on the first 2 GPUs:-o Global.device=gpu:0,1
; to set the number of training epochs to 10:-o Train.epochs_iters=10
. For more modifiable parameters and their detailed explanations, refer to the configuration file parameter instructions for the corresponding task module of the model PaddleX Common Model Configuration File Parameters.
👉 More Details (Click to Expand)
- During model training, PaddleX automatically saves the model weight files, with the default being
output
. If you need to specify a save path, you can set it through the-o Global.output
field in the configuration file. - PaddleX shields you from the concepts of dynamic graph weights and static graph weights. During model training, both dynamic and static graph weights are produced, and static graph weights are selected by default for model inference.
-
After completing the model training, all outputs are saved in the specified output directory (default is
./output/
), typically including: -
train_result.json
: Training result record file, recording whether the training task was completed normally, as well as the output weight metrics, related file paths, etc.; train.log
: Training log file, recording changes in model metrics and loss during training;config.yaml
: Training configuration file, recording the hyperparameter configuration for this training session;.pdparams
,.pdema
,.pdopt.pdstate
,.pdiparams
,.pdmodel
: Model weight-related files, including network parameters, optimizer, EMA, static graph network parameters, static graph network structure, etc.;
4.3 Model Evaluation¶
After completing model training, you can evaluate the specified model weights file on the validation set to verify the model's accuracy. Using PaddleX for model evaluation can be done with a single command:
python main.py -c paddlex/configs/modules/pedestrian_attribute_recognition/PP-LCNet_x1_0_pedestrian_attribute.yaml \
-o Global.mode=evaluate \
-o Global.dataset_dir=./dataset/pedestrian_attribute_examples
- Specify the path to the model's
.yaml
configuration file (here it isPP-LCNet_x1_0_pedestrian_attribute.yaml
) - Specify the mode as model evaluation:
-o Global.mode=evaluate
- Specify the path to the validation dataset:
-o Global.dataset_dir
Other related parameters can be set by modifying theGlobal
andEvaluate
fields in the.yaml
configuration file. For details, refer to PaddleX Common Model Configuration File Parameter Description.
👉 More Details (Click to Expand)
When evaluating the model, you need to specify the model weights file path. Each configuration file has a default weight save path built-in. If you need to change it, simply set it by appending a command line parameter, such as -o Evaluate.weight_path=./output/best_model/best_model.pdparams
.
After completing the model evaluation, an evaluate_result.json
file will be produced, which records the evaluation results, specifically, whether the evaluation task was completed successfully and the model's evaluation metrics, including MultiLabelMAP;
4.4 Model Inference and Integration¶
After completing model training and evaluation, you can use the trained model weights for inference prediction or Python integration.
4.4.1 Model Inference¶
To perform inference prediction through the command line, simply use the following command. Before running the following code, please download the demo image to your local machine.
python main.py -c paddlex/configs/modules/pedestrian_attribute_recognition/PP-LCNet_x1_0_pedestrian_attribute.yaml \
-o Global.mode=predict \
-o Predict.model_dir="./output/best_model/inference" \
-o Predict.input="pedestrian_attribute_006.jpg"
- Specify the path to the model's
.yaml
configuration file (here it isPP-LCNet_x1_0_pedestrian_attribute.yaml
) - Specify the mode as model inference prediction:
-o Global.mode=predict
- Specify the model weights path:
-o Predict.model_dir="./output/best_model/inference"
- Specify the input data path:
-o Predict.input="..."
. Other related parameters can be set by modifying theGlobal
andPredict
fields in the.yaml
configuration file. For details, refer to PaddleX Common Model Configuration File Parameter Description.
4.4.2 Model Integration¶
The model can be directly integrated into the PaddleX pipeline or directly into your own project.
1.Pipeline Integration
The pedestrian attribute recognition module can be integrated into the Pedestrian Attribute Recognition Pipeline of PaddleX. Simply replace the model path to update the pedestrian attribute recognition module of the relevant pipeline. In pipeline integration, you can use high-performance inference and service-oriented deployment to deploy your model.
2.Module Integration
The weights you produce can be directly integrated into the pedestrian attribute recognition module. Refer to the Python example code in Quick Integration and simply replace the model with the path to your trained model.
You can also use the PaddleX high-performance inference plugin to optimize the inference process of your model and further improve efficiency. For detailed procedures, please refer to the PaddleX High-Performance Inference Guide.