Skip to content

refactor: update parameter names#48

Merged
ktro2828 merged 1 commit intomainfrom
refactor/parameter-name
Sep 27, 2025
Merged

refactor: update parameter names#48
ktro2828 merged 1 commit intomainfrom
refactor/parameter-name

Conversation

@ktro2828
Copy link
Copy Markdown
Owner

Description

This pull request refactors the way ONNX model paths and parameter files are handled across multiple project configurations and launch files. The main goal is to standardize variable names and improve clarity by replacing generic path variables with more descriptive ones, and by adding helpful descriptions to launch arguments.

Key changes include:

  • Replacing the use of data_path with directory/onnx for specifying ONNX model directories in parameter files.
  • Updating launch files to use file/parameter and directory/onnx argument names, along with adding descriptions for better readability and maintainability.
  • Ensuring all launch files and parameter files across projects follow this new convention.

The most important changes are:

Standardization of ONNX Model Path Variables:

  • All parameter YAML files now use $(var directory/onnx) instead of $(var data_path) to specify the ONNX model location, improving clarity and consistency for model directory references. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Refactoring and Documentation of Launch Arguments:

  • Launch files now use file/parameter and directory/onnx as argument names instead of param_path and data_path, and each argument is supplemented with a clear description, making the launch files more user-friendly and self-documenting. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Consistent Parameter Passing in Launch Files:

  • All <param from=...> tags in launch files now reference $(var file/parameter) instead of the old variable, ensuring consistency in how parameter files are loaded. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Improved Argument Documentation:

  • All launch arguments (such as input/output topics, use_raw, build_only, visualize) now include descriptions, making it easier for users to understand their purpose. [1] [2] [3] [4] [5] [6] [7] [8] [9]

These changes collectively improve maintainability, readability, and usability of the configuration and launch files across all supported projects.

How was this PR tested?

Notes for reviewers

None.

Effects on system behavior

None.

Copilot AI review requested due to automatic review settings September 27, 2025 20:29
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request refactors parameter and path variable names across multiple machine learning project configurations to improve clarity and consistency. The changes standardize how ONNX model paths and parameter files are referenced throughout the codebase.

  • Replaces generic param_path and data_path variables with more descriptive file/parameter and directory/onnx names
  • Adds comprehensive descriptions to all launch file arguments for better documentation
  • Ensures consistent variable naming across all project configurations

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
projects/yolox/launch/yolox.launch.xml Updates argument names and adds descriptions for YOLOX launch configuration
projects/yolox/config/yolox.param.yaml Updates ONNX path variable reference for YOLOX parameters
projects/rtmdet/launch/rtmdet.launch.xml Updates argument names and adds descriptions for RTMDet launch configuration
projects/rtmdet/config/rtmdet.param.yaml Updates ONNX path variable reference for RTMDet parameters
projects/rfdetr/launch/rfdetr.launch.xml Updates argument names and adds descriptions for RFDETR launch configuration
projects/rfdetr/config/rfdetr.param.yaml Updates ONNX path variable reference for RFDETR parameters
projects/pidnet/launch/pidnet.launch.xml Updates argument names and adds descriptions for PIDNet launch configuration
projects/pidnet/config/pidnet.param.yaml Updates ONNX path variable reference for PIDNet parameters
projects/panoptic_fpn/launch/panoptic_fpn.launch.xml Updates argument names and adds descriptions for Panoptic FPN launch configuration
projects/panoptic_fpn/config/panoptic_fpn.param.yaml Updates ONNX path variable reference for Panoptic FPN parameters
projects/mask2former/launch/mask2former.launch.xml Updates argument names and adds descriptions for Mask2Former launch configuration
projects/mask2former/config/mask2former.param.yaml Updates ONNX path variable reference for Mask2Former parameters
projects/instance_rtmdet/launch/instance_rtmdet.launch.xml Updates argument names and adds descriptions for Instance RTMDet launch configuration
projects/instance_rtmdet/config/instance_rtmdet.param.yaml Updates ONNX path variable reference for Instance RTMDet parameters
projects/detr/launch/detr.launch.xml Updates argument names and adds descriptions for DETR launch configuration
projects/detr/config/detr.param.yaml Updates ONNX path variable reference for DETR parameters
projects/deimv2/launch/deimv2.launch.xml Updates argument names and adds descriptions for DEIMv2 launch configuration
projects/deimv2/config/deimv2.param.yaml Updates ONNX path variable reference for DEIMv2 parameters

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread projects/rfdetr/launch/rfdetr.launch.xml Outdated
Comment thread projects/rfdetr/launch/rfdetr.launch.xml Outdated
Comment thread projects/panoptic_fpn/launch/panoptic_fpn.launch.xml Outdated
Comment thread projects/panoptic_fpn/launch/panoptic_fpn.launch.xml Outdated
Comment thread projects/mask2former/launch/mask2former.launch.xml Outdated
Comment thread projects/mask2former/launch/mask2former.launch.xml Outdated
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
@ktro2828 ktro2828 force-pushed the refactor/parameter-name branch from b370cc2 to 05c6c14 Compare September 27, 2025 20:33
@ktro2828 ktro2828 merged commit d74fdf1 into main Sep 27, 2025
1 check failed
@ktro2828 ktro2828 deleted the refactor/parameter-name branch September 27, 2025 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants