From 88ec105322d6f0b72bd458a6ceeb3c7875e4924c Mon Sep 17 00:00:00 2001 From: gaotingquan Date: Thu, 29 Jun 2023 03:39:02 +0000 Subject: [PATCH] docs: fix link --- docs/en/PULC/PULC_car_exists_en.md | 2 +- docs/en/PULC/PULC_code_exists_en.md | 2 +- .../PULC/PULC_language_classification_en.md | 2 +- docs/en/PULC/PULC_person_attribute_en.md | 2 +- docs/en/PULC/PULC_person_exists_en.md | 2 +- docs/en/PULC/PULC_safety_helmet_en.md | 2 +- .../en/PULC/PULC_text_image_orientation_en.md | 2 +- docs/en/PULC/PULC_textline_orientation_en.md | 2 +- docs/en/PULC/PULC_traffic_sign_en.md | 2 +- docs/en/PULC/PULC_vehicle_attribute_en.md | 2 +- .../knowledge_distillation_en.md | 2 +- .../inference_deployment/export_model_en.md | 2 +- .../inference_deployment/python_deploy_en.md | 2 +- docs/en/models/PP-HGNet_en.md | 2 +- docs/en/models/PP-LCNet_en.md | 2 +- docs/en/models_training/classification_en.md | 2 +- docs/en/models_training/recognition_en.md | 2 +- .../quick_start_classification_new_user_en.md | 4 ++-- ...ck_start_classification_professional_en.md | 20 +++++++++---------- ...uick_start_multilabel_classification_en.md | 2 +- .../quick_start/quick_start_recognition_en.md | 2 +- 21 files changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/en/PULC/PULC_car_exists_en.md b/docs/en/PULC/PULC_car_exists_en.md index 91cc3733..8338c909 100644 --- a/docs/en/PULC/PULC_car_exists_en.md +++ b/docs/en/PULC/PULC_car_exists_en.md @@ -137,7 +137,7 @@ print(next(result)) ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/PULC/PULC_code_exists_en.md b/docs/en/PULC/PULC_code_exists_en.md index 1cd245b5..51d24bf9 100644 --- a/docs/en/PULC/PULC_code_exists_en.md +++ b/docs/en/PULC/PULC_code_exists_en.md @@ -139,7 +139,7 @@ print(next(result)) ### 3.1 Installation -* Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +* Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/PULC/PULC_language_classification_en.md b/docs/en/PULC/PULC_language_classification_en.md index 450f3e75..a1f1d748 100644 --- a/docs/en/PULC/PULC_language_classification_en.md +++ b/docs/en/PULC/PULC_language_classification_en.md @@ -136,7 +136,7 @@ print(next(result)) ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/PULC/PULC_person_attribute_en.md b/docs/en/PULC/PULC_person_attribute_en.md index 3d6f70fc..b2176f37 100644 --- a/docs/en/PULC/PULC_person_attribute_en.md +++ b/docs/en/PULC/PULC_person_attribute_en.md @@ -160,7 +160,7 @@ print(next(result)) ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/PULC/PULC_person_exists_en.md b/docs/en/PULC/PULC_person_exists_en.md index 31d452fd..8ace79b6 100644 --- a/docs/en/PULC/PULC_person_exists_en.md +++ b/docs/en/PULC/PULC_person_exists_en.md @@ -136,7 +136,7 @@ print(next(result)) ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/PULC/PULC_safety_helmet_en.md b/docs/en/PULC/PULC_safety_helmet_en.md index d79b4afe..352286e0 100644 --- a/docs/en/PULC/PULC_safety_helmet_en.md +++ b/docs/en/PULC/PULC_safety_helmet_en.md @@ -137,7 +137,7 @@ print(next(result)) ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/PULC/PULC_text_image_orientation_en.md b/docs/en/PULC/PULC_text_image_orientation_en.md index cf530905..9d3703b5 100644 --- a/docs/en/PULC/PULC_text_image_orientation_en.md +++ b/docs/en/PULC/PULC_text_image_orientation_en.md @@ -133,7 +133,7 @@ print(next(result)) ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/PULC/PULC_textline_orientation_en.md b/docs/en/PULC/PULC_textline_orientation_en.md index fc4d540b..a4eeae1b 100644 --- a/docs/en/PULC/PULC_textline_orientation_en.md +++ b/docs/en/PULC/PULC_textline_orientation_en.md @@ -138,7 +138,7 @@ print(next(result)) ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/PULC/PULC_traffic_sign_en.md b/docs/en/PULC/PULC_traffic_sign_en.md index e235ca92..97066a3f 100644 --- a/docs/en/PULC/PULC_traffic_sign_en.md +++ b/docs/en/PULC/PULC_traffic_sign_en.md @@ -136,7 +136,7 @@ print(next(result)) ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/PULC/PULC_vehicle_attribute_en.md b/docs/en/PULC/PULC_vehicle_attribute_en.md index b831e710..15af75f8 100644 --- a/docs/en/PULC/PULC_vehicle_attribute_en.md +++ b/docs/en/PULC/PULC_vehicle_attribute_en.md @@ -142,7 +142,7 @@ print(next(result)) ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/advanced_tutorials/knowledge_distillation_en.md b/docs/en/advanced_tutorials/knowledge_distillation_en.md index a6672b80..b3f697e5 100644 --- a/docs/en/advanced_tutorials/knowledge_distillation_en.md +++ b/docs/en/advanced_tutorials/knowledge_distillation_en.md @@ -805,7 +805,7 @@ Loss: ### 2.1 Environment Configuration -* Installation: Please refer to [Paddle Installation Tutorial](../installation/install_paddle_en.md) and [PaddleClas Installation Tutorial](../installation/install_paddleclas_en.md) to configure the running environment. +* Installation: Please refer to [Installation Tutorial](../installation.md) to configure the running environment. diff --git a/docs/en/inference_deployment/export_model_en.md b/docs/en/inference_deployment/export_model_en.md index 062ee1bc..32f20405 100644 --- a/docs/en/inference_deployment/export_model_en.md +++ b/docs/en/inference_deployment/export_model_en.md @@ -17,7 +17,7 @@ PaddlePaddle supports exporting inference model for deployment. Compared with tr ## 1. Environmental preparation -First, refer to the [Installing PaddlePaddle](../installation/install_paddle_en.md) and the [Installing PaddleClas](../installation/install_paddleclas_en.md) to prepare environment. +First, refer to the [Installing PaddleClas](../installation.md) to prepare environment. diff --git a/docs/en/inference_deployment/python_deploy_en.md b/docs/en/inference_deployment/python_deploy_en.md index 22dd4e60..c26c44ab 100644 --- a/docs/en/inference_deployment/python_deploy_en.md +++ b/docs/en/inference_deployment/python_deploy_en.md @@ -6,7 +6,7 @@ The model saved during the training process is the checkpoints model, which save Compared with the checkpoints model, the inference model will additionally save the structural information of the model. Therefore, it is easier to deploy because the model structure and model parameters are already solidified in the inference model file, and is suitable for integration with actual systems. -Please refer to the document [install paddle](../installation/install_paddle_en.md) and [install paddleclas](../installation/install_paddleclas_en.md) to prepare the environment. +Please refer to the document [install paddleclas](../installation.md) to prepare the environment. --- diff --git a/docs/en/models/PP-HGNet_en.md b/docs/en/models/PP-HGNet_en.md index 0184e158..7e50c6e6 100644 --- a/docs/en/models/PP-HGNet_en.md +++ b/docs/en/models/PP-HGNet_en.md @@ -170,7 +170,7 @@ The result of demo above: ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/models/PP-LCNet_en.md b/docs/en/models/PP-LCNet_en.md index d5786996..be1a5365 100644 --- a/docs/en/models/PP-LCNet_en.md +++ b/docs/en/models/PP-LCNet_en.md @@ -220,7 +220,7 @@ The result of demo above: ### 3.1 Installation -Please refer to [Installation](../installation/install_paddleclas_en.md) to get the description about installation. +Please refer to [Installation](../installation.md) to get the description about installation. diff --git a/docs/en/models_training/classification_en.md b/docs/en/models_training/classification_en.md index d6a742bd..5d0fcf93 100644 --- a/docs/en/models_training/classification_en.md +++ b/docs/en/models_training/classification_en.md @@ -86,7 +86,7 @@ After a model is trained, the evaluation results of the model on the validation ## 3. Application Methods -Please refer to [Installation](../installation/install_paddleclas_en.md) to setup environment at first, and prepare flower102 dataset by following the instruction mentioned in the [Quick Start](../quick_start/quick_start_classification_new_user_en.md). +Please refer to [Installation](../installation.md) to setup environment at first, and prepare flower102 dataset by following the instruction mentioned in the [Quick Start](../quick_start/quick_start_classification_new_user_en.md). So far, PaddleClas supports the following training/evaluation environments: diff --git a/docs/en/models_training/recognition_en.md b/docs/en/models_training/recognition_en.md index 57f2b126..638754f2 100644 --- a/docs/en/models_training/recognition_en.md +++ b/docs/en/models_training/recognition_en.md @@ -16,7 +16,7 @@ The feature gallery is built in advance using the labeled image datasets. The co To experience the whole image recognition system, or learn how to build a feature gallery, please refer to [Quick Start of Image Recognition](../quick_start/quick_start_recognition_en.md), which explains the overall application process. The following parts expound on the training part of the above three steps. -Please first refer to the [Installation Guide](../installation/install_paddleclas_en.md) to configure the runtime environment. +Please first refer to the [Installation Guide](../installation.md) to configure the runtime environment. ## Catalogue diff --git a/docs/en/quick_start/quick_start_classification_new_user_en.md b/docs/en/quick_start/quick_start_classification_new_user_en.md index 12a5e741..2f1dc4dd 100644 --- a/docs/en/quick_start/quick_start_classification_new_user_en.md +++ b/docs/en/quick_start/quick_start_classification_new_user_en.md @@ -48,7 +48,7 @@ Image classification is a pattern classification problem, which is the most basi ## 2. Environmental installation and configuration -For specific installation steps, please refer to [Paddle Installation Document](../installation/install_paddle_en.md), [PaddleClas Installation Document](../installation/install_paddleclas_en.md). +For specific installation steps, please refer to [Installation Document](../installation.md). ## 3. Data preparation and processing @@ -191,4 +191,4 @@ The `-i` parameter can also be the directory of the image file to be tested (`da `[{'class_ids': [76, 51, 37, 33, 9], 'scores': [0.99998, 0.0, 0.0, 0.0, 0.0], 'file_name': 'dataset/flowers102/jpg/image_00001.jpg', 'label_names': ['passion flower', 'wild pansy', 'great masterwort', 'mexican aster', 'globe thistle']}, {'class_ids': [76, 51, 37, 33, 32], 'scores': [0.99999, 0.0, 0.0, 0.0, 0.0], 'file_name': 'dataset/flowers102/jpg/image_00002.jpg', 'label_names': ['passion flower', 'wild pansy', 'great masterwort', 'mexican aster', 'love in the mist']}, {'class_ids': [76, 12, 39, 73, 78], 'scores': [0.99998, 0.0, 0.0, 0.0, 0.0], 'file_name': 'dataset/flowers102/jpg/image_00003.jpg', 'label_names': ['passion flower', 'king protea', 'lenten rose', 'rose', 'toad lily']}, {'class_ids': [76, 37, 34, 12, 9], 'scores': [0.86282, 0.11177, 0.00717, 0.00599, 0.00397], 'file_name': 'dataset/flowers102/jpg/image_00004.jpg', 'label_names': ['passion flower', 'great masterwort', 'alpine sea holly', 'king protea', 'globe thistle']}, {'class_ids': [76, 37, 33, 51, 69], 'scores': [0.9999, 1e-05, 1e-05, 0.0, 0.0], 'file_name': 'dataset/flowers102/jpg/image_00005.jpg', 'label_names': ['passion flower', 'great masterwort', 'mexican aster', 'wild pansy', 'tree poppy']}, {'class_ids': [76, 37, 51, 33, 73], 'scores': [0.99999, 0.0, 0.0, 0.0, 0.0], 'file_name': 'dataset/flowers102/jpg/image_00006.jpg', 'label_names': ['passion flower', 'great masterwort', 'wild pansy', 'mexican aster', 'rose']}, {'class_ids': [76, 37, 12, 91, 30], 'scores': [0.98746, 0.00211, 0.00201, 0.00136, 0.0007], 'file_name': 'dataset/flowers102/jpg/image_00007.jpg', 'label_names': ['passion flower', 'great masterwort', 'king protea', 'bee balm', 'carnation']}, {'class_ids': [76, 37, 81, 77, 72], 'scores': [0.99976, 3e-05, 2e-05, 2e-05, 1e-05], 'file_name': 'dataset/flowers102/jpg/image_00008.jpg', 'label_names': ['passion flower', 'great masterwort', 'clematis', 'lotus', 'water lily']}, {'class_ids': [76, 37, 13, 12, 34], 'scores': [0.99646, 0.00144, 0.00092, 0.00035, 0.00027], 'file_name': 'dataset/flowers102/jpg/image_00009.jpg', 'label_names': ['passion flower', 'great masterwort', 'spear thistle', 'king protea', 'alpine sea holly']}, {'class_ids': [76, 37, 34, 33, 51], 'scores': [0.99999, 0.0, 0.0, 0.0, 0.0], 'file_name': 'dataset/flowers102/jpg/image_00010.jpg', 'label_names': ['passion flower', 'great masterwort', 'alpine sea holly', 'mexican aster', 'wild pansy']}]` -Among them, the length of the list is the size of batch_size. \ No newline at end of file +Among them, the length of the list is the size of batch_size. diff --git a/docs/en/quick_start/quick_start_classification_professional_en.md b/docs/en/quick_start/quick_start_classification_professional_en.md index 840643aa..3baca3c7 100644 --- a/docs/en/quick_start/quick_start_classification_professional_en.md +++ b/docs/en/quick_start/quick_start_classification_professional_en.md @@ -1,6 +1,6 @@ # Trial in 30mins(professional) -Here is a quick start tutorial for professional users to use PaddleClas on the Linux operating system. The main content is based on the CIFAR-100 data set. You can quickly experience the training of different models, experience loading different pre-trained models, experience the SSLD knowledge distillation solution, and experience data augmentation. Please refer to [Installation Guide](../installation/install_paddleclas_en.md) to configure the operating environment and clone PaddleClas code. +Here is a quick start tutorial for professional users to use PaddleClas on the Linux operating system. The main content is based on the CIFAR-100 data set. You can quickly experience the training of different models, experience loading different pre-trained models, experience the SSLD knowledge distillation solution, and experience data augmentation. Please refer to [Installation Guide](../installation.md) to configure the operating environment and clone PaddleClas code. ------ @@ -37,7 +37,7 @@ Here is a quick start tutorial for professional users to use PaddleClas on the L cd path_to_PaddleClas ``` - + #### 1.1.1 Prepare CIFAR100 @@ -54,11 +54,11 @@ cd ../ ## 2. Model training - + ### 2.1 Single label training - + #### 2.1.1 Training without loading the pre-trained model @@ -93,7 +93,7 @@ python3 -m paddle.distributed.launch \ * Since the initial learning rate and batch-size need to maintain a linear relationship, when training is switched from 4 GPUs to 1 GPU, the total batch-size is reduced to 1/4 of the original, and the learning rate also needs to be reduced to 1/4 of the original, so changed the default learning rate from 0.04 to 0.01. - + #### 2.1.2 Transfer learning @@ -148,7 +148,7 @@ The highest accuracy of the validation set is about 0.601, which is nearly 12% l PaddleClas contains many data augmentation methods, such as Mixup, Cutout, RandomErasing, etc. For specific methods, please refer to [Data augmentation chapter](../algorithm_introduction/DataAugmentation_en.md)。 - + ### 3.1 Data augmentation-Mixup @@ -245,11 +245,11 @@ In the end, the accuracy on the CIFAR100 validation set was 64.4%. Using the tea ## 5. Model evaluation and inference - + ### 5.1 Single-label classification model evaluation and inference - + #### 5.1.1 Single-label classification model evaluation @@ -261,7 +261,7 @@ python3 tools/eval.py \ -o Global.pretrained_model="output_CIFAR/ResNet50_vd/best_model" ``` - + #### 5.1.2 Single-label classification model prediction @@ -274,7 +274,7 @@ python3 tools/infer.py \ -o Global.pretrained_model=output_CIFAR/ResNet50_vd/best_model ``` - + #### 5.1.3 Single-label classification uses inference model for model inference diff --git a/docs/en/quick_start/quick_start_multilabel_classification_en.md b/docs/en/quick_start/quick_start_multilabel_classification_en.md index 8d267773..1ace50b4 100644 --- a/docs/en/quick_start/quick_start_multilabel_classification_en.md +++ b/docs/en/quick_start/quick_start_multilabel_classification_en.md @@ -1,6 +1,6 @@ # Quick Start of Multi-label Classification -Experience the training, evaluation, and prediction of multi-label classification based on the [NUS-WIDE-SCENE](https://lms.comp.nus.edu.sg/wp-content/uploads/2019/research/nuswide/NUS-WIDE.html) dataset, which is a subset of the NUS-WIDE dataset. Please first install PaddlePaddle and PaddleClas, see [Paddle Installation](../installation/install_paddle_en.md) and [PaddleClas installation](../installation/install_paddleclas_en.md) for more details. +Experience the training, evaluation, and prediction of multi-label classification based on the [NUS-WIDE-SCENE](https://lms.comp.nus.edu.sg/wp-content/uploads/2019/research/nuswide/NUS-WIDE.html) dataset, which is a subset of the NUS-WIDE dataset. Please first install PaddlePaddle and PaddleClas, see [Installation Doc](../installation.md) for more details. ## Catalogue diff --git a/docs/en/quick_start/quick_start_recognition_en.md b/docs/en/quick_start/quick_start_recognition_en.md index cc84ccf4..bce71cfd 100644 --- a/docs/en/quick_start/quick_start_recognition_en.md +++ b/docs/en/quick_start/quick_start_recognition_en.md @@ -99,7 +99,7 @@ One can preview it according to the instructions in [Function Experience - Previ ### 2.1 Environment configuration -* Installation: Please refer to the document [Environment Preparation](../installation/install_paddleclas_en.md) to configure the PaddleClas operating environment. +* Installation: Please refer to the document [Environment Preparation](../installation.md) to configure the PaddleClas operating environment. * Go to the `deploy` run directory. All the content and scripts in this section need to be run in the `deploy` directory, you can enter the `deploy` directory with the following scripts. -- GitLab