[TVMC] Enhance the --help message of codegen target #13798

MNGanesan · 2023-01-17T13:16:15Z

Presently --help for vitis displays the target and option string,
it has no description. Eg: target vitis-ai dpu<class 'str'>

This can be made more meaningful by fetching the description from the config node of the target. Eg: Vitis AI DPU identifier

Signed-off-by: MNGanesan mnganesan@yahoo.co.uk

tvm-bot · 2023-01-17T13:16:18Z

Thanks for contributing to TVM! Please refer to the contributing guidelines https://tvm.apache.org/docs/contribute/ for useful information and tips. Please request code reviews from Reviewers by @-ing them in a comment.

cc @Mousius, @gromero, @leandron _{See #10317 for details}

_{Generated by tvm-bot}

MNGanesan · 2023-01-17T13:29:00Z

Present --help string has no meaningful description, it simply prints the target, option name and python type


target vitis-ai:
  --target-vitis-ai-dpu TARGET_VITIS_AI_DPU
                        **target vitis-ai dpu<class 'str'>**
  --target-vitis-ai-build_dir TARGET_VITIS_AI_BUILD_DIR
                        **target vitis-ai build_dir<class 'str'>**
  --target-vitis-ai-work_dir TARGET_VITIS_AI_WORK_DIR
                        **target vitis-ai work_dir<class 'str'>**
  --target-vitis-ai-export_runtime_module TARGET_VITIS_AI_EXPORT_RUNTIME_MODULE
                        **target vitis-ai export_runtime_module<class 'str'>**
  --target-vitis-ai-load_runtime_module TARGET_VITIS_AI_LOAD_RUNTIME_MODULE
                        **target vitis-ai load_runtime_module<class 'str'>**

This can be enhanced by accessing the config node of codegen target, which has meaningful descritption.
It is retrieved in the front end using the "field.description" of config

struct VitisAICompilerConfigNode : public tvm::AttrsNode<VitisAICompilerConfigNode> {
  String dpu;
  String build_dir;
  String work_dir;
  String export_runtime_module;
  String load_runtime_module;
  TVM_DECLARE_ATTRS(VitisAICompilerConfigNode, "ext.attrs.VitisAICompilerConfigNode") {
    TVM_ATTR_FIELD(dpu).describe("Vitis AI DPU identifier").set_default("");
    TVM_ATTR_FIELD(build_dir)
        .describe("Build directory to be used (optional, debug)")
        .set_default("");
    TVM_ATTR_FIELD(work_dir)
        .describe("Work directory to be used (optional, debug)")
        .set_default("");
    TVM_ATTR_FIELD(export_runtime_module)
        .describe("Export the Vitis AI runtime module to this file")
        .set_default("");
    TVM_ATTR_FIELD(load_runtime_module)

Enhanced --help string after the fix

target vitis-ai:

  --target-vitis-ai-dpu TARGET_VITIS_AI_DPU
                        **Vitis AI DPU identifier**
  --target-vitis-ai-build_dir TARGET_VITIS_AI_BUILD_DIR
                        **Build directory to be used (optional, debug)**
  --target-vitis-ai-work_dir TARGET_VITIS_AI_WORK_DIR
                        **Work directory to be used (optional, debug)**
  --target-vitis-ai-export_runtime_module TARGET_VITIS_AI_EXPORT_RUNTIME_MODULE
                        **Export the Vitis AI runtime module to this file**
  --target-vitis-ai-load_runtime_module TARGET_VITIS_AI_LOAD_RUNTIME_MODULE
                        **Load the Vitis AI runtime module to this file**

lhutton1

Thanks @MNGanesan this looks like a sensible change to me. Would it be possible to add a test to check this case perhaps in tests/python/driver/tvmc/test_target_options.py?

Also cc @Mousius

Mousius

This looks like an awesome change, the original author made an odd choice here 🤔

Please add a test 😸

MNGanesan · 2023-01-18T06:27:54Z

Thanks @lhutton1 @Mousius , I'll working on the test and add it shortly

leandron · 2023-01-18T09:25:47Z

@tvm-bot rerun

via the pull request apache#13798 Here, adding test cases to verify the fix Signed-off-by: MNGanesan <mnganesan@yahoo.co.uk>

MNGanesan · 2023-01-24T14:08:28Z

Added the test via commit

commit f6bfd9a (HEAD -> main, origin/main, origin/HEAD)
Author: MNGanesan mnganesan@yahoo.co.uk
Date: Tue Jan 24 13:58:00 2023 +0000

MNGanesan · 2023-01-24T14:11:07Z

Pushed the test via commit commit f6bfd9a (HEAD -> main, origin/main, origin/HEAD)Author: MNGanesan ***@***.***>Date: Tue Jan 24 13:58:00 2023 +0000 Thanks,Ganesan On Tuesday, 17 January 2023 at 19:30:52 GMT+5:30, Luke Hutton ***@***.***> wrote: @lhutton1 commented on this pull request. Thanks @MNGanesan this looks like a sensible change to me. Would it be possible to add a test to check this case perhaps in tests/python/driver/tvmc/test_target_options.py? Also cc @Mousius — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>

MNGanesan · 2023-01-24T14:11:28Z

Pushed the test via commit commit f6bfd9a (HEAD -> main, origin/main, origin/HEAD)Author: MNGanesan ***@***.***>Date: Tue Jan 24 13:58:00 2023 +0000 Thanks,Ganesan On Wednesday, 18 January 2023 at 14:56:00 GMT+5:30, Leandro Nunes ***@***.***> wrote: @tvm-bot rerun — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>

lhutton1

Thanks for adding the test @MNGanesan, it looks good to me :)

I took a quick look at the CI failures and they seem unrelated to your change. I wonder if your branch may need to be rebased onto the latest main?

MNGanesan · 2023-01-25T08:16:03Z

Dropping this PR, moved by fix and test to new PR #13842 under my branch enhance_help_msg

MNGanesan · 2023-01-25T08:57:30Z

Thanks @lhutton, I've moved the fix to new PR under a new branch Enhance the --help message of composite target by MNGanesan · Pull Request #13842 · apache/tvm | | | | | | | | | | | Enhance the --help message of composite target by MNGanesan · Pull Reque... Presently --help for vitis displays the target and option string, it has no description. Eg: target vitis-ai d... | | | Thanks,Ganesan On Wednesday, 25 January 2023 at 00:25:23 GMT+5:30, Luke Hutton ***@***.***> wrote: @lhutton1 commented on this pull request. Thanks for adding the test @MNGanesan, it looks good to me :) I took a quick look at the CI failures and they seem unrelated to your change. I wonder if your branch may need to be rebased onto the latest main? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>

MNGanesan · 2023-01-25T08:58:15Z

Thanks,Ganesan On Wednesday, 25 January 2023 at 14:27:25 GMT+5:30, M N Ganesan ***@***.***> wrote: Thanks @lhutton, I've moved the fix to new PR under a new branch Enhance the --help message of composite target by MNGanesan · Pull Request #13842 · apache/tvm | | | | | | | | | | | Enhance the --help message of composite target by MNGanesan · Pull Reque... Presently --help for vitis displays the target and option string, it has no description. Eg: target vitis-ai d... | | | Thanks,Ganesan On Wednesday, 25 January 2023 at 00:25:23 GMT+5:30, Luke Hutton ***@***.***> wrote: @lhutton1 commented on this pull request. Thanks for adding the test @MNGanesan, it looks good to me :) I took a quick look at the CI failures and they seem unrelated to your change. I wonder if your branch may need to be rebased onto the latest main? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>

MNGanesan changed the title ~~Enhance the --help message of composite target's option description~~ Enhance the --help message of composite target Jan 17, 2023

lhutton1 reviewed Jan 17, 2023

View reviewed changes

lhutton1 changed the title ~~Enhance the --help message of composite target~~ [TVMC] Enhance the --help message of composite target Jan 17, 2023

Mousius changed the title ~~[TVMC] Enhance the --help message of composite target~~ [TVMC] Enhance the --help message of codegen target Jan 17, 2023

Mousius requested changes Jan 17, 2023

View reviewed changes

MNGanesan added a commit to MNGanesan/tvm that referenced this pull request Jan 24, 2023

Enhanced the --help message of composite target (like vitis-ai)

f6bfd9a

via the pull request apache#13798 Here, adding test cases to verify the fix Signed-off-by: MNGanesan <mnganesan@yahoo.co.uk>

lhutton1 reviewed Jan 24, 2023

View reviewed changes

MNGanesan closed this Jan 25, 2023

MNGanesan force-pushed the main branch from f6bfd9a to 1258863 Compare January 25, 2023 07:11

[TVMC] Enhance the --help message of codegen target #13798

[TVMC] Enhance the --help message of codegen target #13798

Uh oh!

Conversation

MNGanesan commented Jan 17, 2023

Uh oh!

tvm-bot commented Jan 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MNGanesan commented Jan 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lhutton1 left a comment

Choose a reason for hiding this comment

Uh oh!

Mousius left a comment

Choose a reason for hiding this comment

Uh oh!

MNGanesan commented Jan 18, 2023

Uh oh!

leandron commented Jan 18, 2023

Uh oh!

MNGanesan commented Jan 24, 2023

Uh oh!

MNGanesan commented Jan 24, 2023 via email

Uh oh!

MNGanesan commented Jan 24, 2023 via email

Uh oh!

lhutton1 left a comment

Choose a reason for hiding this comment

Uh oh!

MNGanesan commented Jan 25, 2023

Uh oh!

MNGanesan commented Jan 25, 2023 via email

Uh oh!

MNGanesan commented Jan 25, 2023 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tvm-bot commented Jan 17, 2023 •

edited

Loading

MNGanesan commented Jan 17, 2023 •

edited

Loading