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

Olive Command Line Tools #1129

Merged
merged 5 commits into from
May 1, 2024
Merged

Olive Command Line Tools #1129

merged 5 commits into from
May 1, 2024

Conversation

jambayk
Copy link
Contributor

@jambayk jambayk commented May 1, 2024

Describe your changes

This PR adds command line tools for Olive that can be called using olive or python -m olive command.

  • Previous commands python -m olive.workflows.run and python -m olive.platform_sdk.qualcomm.configure are deprecated and will emit a FutureWarning.
  • All cli commands are implemented in the olive.cli sub-module. These must handle the command parsing and, in some cases, the implementation of the command too.
  • Removed olive.workflows.snpe sub-module since the code is outdated and obsolete.
  • Some doc fixes where we need to use "``" instead of "`" for code formatting.
  • Documentation is automatic using the sphinx-argparse extension:
    image

Checklist before requesting a review

  • Add unit tests for this change.
  • Make sure all tests can pass.
  • Update documents if necessary.
  • Lint and apply fixes to your code by running lintrunner -a
  • Is this a user-facing change? If yes, give a description of this change to be included in the release notes.
    • olive command line tool has been added.
    • Use olive run or python -m olive instead of python -m olive.workflows.run which has been deprecated.
  • Is this PR including examples changes? If yes, please remember to update example documentation in a follow-up PR.

(Optional) Issue link

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

olive/cli/configure_qualcomm_sdk.py Fixed Show resolved Hide resolved
olive/cli/launcher.py Fixed Show resolved Hide resolved
use sys.executable to call
nit

separate configure implementation from call to fix codeql cyclic import

Revert "separate configure implementation from call to fix codeql cyclic import"

This reverts commit 3c858a8.

remove main from impl file

unused import
Copy link
Contributor

@shaahji shaahji left a comment

Choose a reason for hiding this comment

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

While you are touching so many of the documentation files, I would recommend adding the language for the commands as well. A lot of them are missing.

Instead of wrapping ``` .... ``` it should be ```sh ..... ```. Or optionally yse bash

docs/source/tutorials/azureml_scripts.md Outdated Show resolved Hide resolved
docs/source/tutorials/configure_auto_optimizer.rst Outdated Show resolved Hide resolved
olive/cli/run.py Show resolved Hide resolved
@jambayk jambayk merged commit d5337d5 into main May 1, 2024
35 checks passed
@jambayk jambayk deleted the jambayk/olive-cli branch May 1, 2024 18:19
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