Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhanced 'build_apk.py' logic & 'README.md' #41

Merged
merged 3 commits into from
May 20, 2024
Merged

Conversation

fangxingSR
Copy link
Contributor

Enhanced 'build_apk.py' logic & 'README.md'.

There was an issue in 'build_apk.py': when only 'qnnsdk' and 'model_path' were provided as inputs, it incorrectly invoked the 'printmenu()' function to display a model selection menu, despite the model always being renamed to 'classification.tflite'. To address this, I adjusted the logic so that the model selection menu is only printed when neither 'model_name' nor 'model_path' is specified by the user. Specifically, I changed line 45 of 'build_apk.py' to read:
```
if not args.model_name and not args.model_path:
```

Additionally, I made several descriptive improvements to the 'README.md' file. Recognizing that newcomers primarily aim to compile and install the ImageClassification application, I included more concise and efficient instructions tailored to their needs, aiming to minimize their trial-and-error process and facilitate a smoother onboarding experience."

   Enhanced 'build_apk.py' logic & 'README.md'.

    There was an issue in 'build_apk.py': when only 'qnnsdk' and 'model_path' were provided as inputs, it incorrectly invoked the 'printmenu()' function to display a model selection menu, despite the model always being renamed to 'classification.tflite'. To address this, I adjusted the logic so that the model selection menu is only printed when neither 'model_name' nor 'model_path' is specified by the user. Specifically, I changed line 45 of 'build_apk.py' to read:
    ```
    if not args.model_name and not args.model_path:
    ```
    
    Additionally, I made several descriptive improvements to the 'README.md' file. Recognizing that newcomers primarily aim to compile and install the ImageClassification application, I included more concise and efficient instructions tailored to their needs, aiming to minimize their trial-and-error process and facilitate a smoother onboarding experience."

Signed-off-by: w <27848155+fangxingSR@users.noreply.github.com>
@fangxingSR fangxingSR closed this May 7, 2024
@fangxingSR fangxingSR reopened this May 7, 2024
@kory
Copy link
Contributor

kory commented May 9, 2024

Thank you!

@@ -2,6 +2,10 @@

1. Java, android-sdk and sdkmanager is already set at user's end
2. User should have Linux QNN SDK in local machine.
3. If models need to be downloaded during the execution of build_apk.py, qai-hub must be installed first according to the[ README.md in ai-hub-models](https://github.com/quic/ai-hub-models/blob/main/README.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you replace qui-hub with AI Hub Models

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for your correction. The document has been revised

@@ -2,6 +2,10 @@

1. Java, android-sdk and sdkmanager is already set at user's end
2. User should have Linux QNN SDK in local machine.
3. If models need to be downloaded during the execution of build_apk.py, qai-hub must be installed first according to the[ README.md in ai-hub-models](https://github.com/quic/ai-hub-models/blob/main/README.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you also move the space before README.md outside of the link text. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was my negligence, thank you for pointing out the mistake. The document has been revised

Replace qai-hub with AI Hub Models.
Remove the leading space in the line starting with [ README.md......

Signed-off-by: w <27848155+fangxingSR@users.noreply.github.com>
Signed-off-by: w <27848155+fangxingSR@users.noreply.github.com>
@kory kory merged commit c2116ba into quic:main May 20, 2024
1 check passed
@kory
Copy link
Contributor

kory commented May 20, 2024

Thanks! Your contribution is included in release 0.6.0, which is being pushed out today.

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.

None yet

2 participants