Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ben-Louis
Ben-Louis committed Jul 21, 2023
1 parent 15aef6f commit 6ac3309
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions docs/en/user_guides/inference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -235,26 +235,26 @@ The `MMPoseInferencer` offers a variety of arguments for customizing pose estima

The inferencer is designed for both visualization and saving predictions. The table below presents the list of arguments available when using the `MMPoseInferencer` for inference, along with their compatibility with 2D and 3D inferencing:

| Argument | Description | 2D | 3D |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --- |
| `show` | Controls the display of the image or video in a pop-up window. | ✔️ | ✔️ |
| `radius` | Sets the visualization keypoint radius. | ✔️ | ✔️ |
| `thickness` | Determines the link thickness for visualization. | ✔️ | ✔️ |
| `kpt_thr` | Sets the keypoint score threshold. Keypoints with scores exceeding this threshold will be displayed. | ✔️ | ✔️ |
| `draw_bbox` | Decides whether to display the bounding boxes of instances. | ✔️ | ✔️ |
| `draw_heatmap` | Decides if the predicted heatmaps should be drawn. | ✔️ | ❌ |
| `black_background` | Decides whether the estimated poses should be displayed on a black background. | ✔️ | ❌ |
| `skeleton_style` | Sets the skeleton style. Options include 'mmpose' (default) and 'openpose'. | ✔️ | ❌ |
| `use_oks_tracking` | Decides whether to use OKS as a similarity measure in tracking. | ❌ | ✔️ |
| `tracking_thr` | Sets the similarity threshold for tracking. | ❌ | ✔️ |
| `norm_pose_2d` | Decides whether to scale the bounding box to the dataset's average bounding box scale and relocate the bounding box to the dataset's average bounding box center. | ❌ | ✔️ |
| `rebase_keypoint_height` | Decides whether to set the lowest keypoint with height 0. | ❌ | ✔️ |
| `num_instances` | Sets the number of instances to visualize in the results. If set to a negative number, all detected instances will be visualized. | ❌ | ✔️ |
| `return_vis` | Decides whether to include visualization images in the results. | ✔️ | ✔️ |
| `vis_out_dir` | Defines the folder path to save the visualization images. If unset, the visualization images will not be saved. | ✔️ | ✔️ |
| `return_datasample` | Determines if the prediction should be returned in the `PoseDataSample` format. | ✔️ | ✔️ |
| `pred_out_dir` | Specifies the folder path to save the predictions. If unset, the predictions will not be saved. | ✔️ | ✔️ |
| `out_dir` | If `vis_out_dir` or `pred_out_dir` is unset, these will be set to `f'{out_dir}/visualization'` or `f'{out_dir}/predictions'`, respectively. | ✔️ | ✔️ |
| Argument | Description | 2D | 3D |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --- |
| `show` | Controls the display of the image or video in a pop-up window. | ✔️ | ✔️ |
| `radius` | Sets the visualization keypoint radius. | ✔️ | ✔️ |
| `thickness` | Determines the link thickness for visualization. | ✔️ | ✔️ |
| `kpt_thr` | Sets the keypoint score threshold. Keypoints with scores exceeding this threshold will be displayed. | ✔️ | ✔️ |
| `draw_bbox` | Decides whether to display the bounding boxes of instances. | ✔️ | ✔️ |
| `draw_heatmap` | Decides if the predicted heatmaps should be drawn. | ✔️ | ❌ |
| `black_background` | Decides whether the estimated poses should be displayed on a black background. | ✔️ | ❌ |
| `skeleton_style` | Sets the skeleton style. Options include 'mmpose' (default) and 'openpose'. | ✔️ | ❌ |
| `use_oks_tracking` | Decides whether to use OKS as a similarity measure in tracking. | ❌ | ✔️ |
| `tracking_thr` | Sets the similarity threshold for tracking. | ❌ | ✔️ |
| `norm_pose_2d` | Decides whether to scale the bounding box to the dataset's average bounding box scale and relocate the bounding box to the dataset's average bounding box center. | ❌ | ✔️ |
| `disable_rebase_keypoint` | Decides whether to set the lowest keypoint with height 0. | ❌ | ✔️ |
| `num_instances` | Sets the number of instances to visualize in the results. If set to a negative number, all detected instances will be visualized. | ❌ | ✔️ |
| `return_vis` | Decides whether to include visualization images in the results. | ✔️ | ✔️ |
| `vis_out_dir` | Defines the folder path to save the visualization images. If unset, the visualization images will not be saved. | ✔️ | ✔️ |
| `return_datasample` | Determines if the prediction should be returned in the `PoseDataSample` format. | ✔️ | ✔️ |
| `pred_out_dir` | Specifies the folder path to save the predictions. If unset, the predictions will not be saved. | ✔️ | ✔️ |
| `out_dir` | If `vis_out_dir` or `pred_out_dir` is unset, these will be set to `f'{out_dir}/visualization'` or `f'{out_dir}/predictions'`, respectively. | ✔️ | ✔️ |

### Model Alias

Expand Down

0 comments on commit 6ac3309

Please sign in to comment.