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.

Sign up for GitHub

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

Jump to bottom

Update Engine's docstring & CLI --help outputs #3658

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Update Engine's docstring & CLI --help outputs #3658

merged 1 commit into from
Jun 25, 2024

Conversation

harimkang
Copy link
Contributor

@harimkang harimkang commented Jun 24, 2024 •
edited
Loading

Summary

  • Update Engine docstrings
  • Enable Help Formatter theme

Before:
image
After:
image

How to test

Checklist

  • I have added unit tests to cover my changes.​
  • I have added integration tests to cover my changes.​
  • I have ran e2e tests and there is no issues.
  • I have added the description of my changes into CHANGELOG in my target branch (e.g., CHANGELOG in develop).​
  • I have updated the documentation in my target branch accordingly (e.g., documentation in develop).
  • I have linked related issues.

License

  • I submit my code changes under the same Apache License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below).
# Copyright (C) 2024 Intel Corporation
# SPDX-License-Identifier: Apache-2.0

@harimkang harimkang changed the title Update Engine's docstring & Help outputs Update Engine's docstring & CLI --help outputs Jun 24, 2024
@harimkang harimkang added the CLI Any changes in OTE CLI label Jun 24, 2024
@harimkang harimkang added this to the 2.1.0 milestone Jun 24, 2024
@harimkang harimkang marked this pull request as ready for review June 24, 2024 07:27
@harimkang harimkang enabled auto-merge (squash) June 24, 2024 08:00
eunwoosh
eunwoosh previously approved these changes Jun 24, 2024
View reviewed changes
@harimkang harimkang changed the base branch from develop to releases/2.1.0 June 24, 2024 08:22
@harimkang harimkang dismissed eunwoosh’s stale review June 24, 2024 08:22

The base branch was changed.

@harimkang harimkang merged commit c01f636 into openvinotoolkit:releases/2.1.0 Jun 25, 2024
13 checks passed
harimkang added a commit that referenced this pull request Jun 26, 2024
@harimkang @yunchu
@kprokofi @eugene123tw @eunwoosh
Merge Back Hot-Fix into develop (#3682)
4827829 
* [hotfix] Update for fix workflow issues (#3668)

* Update README & CODEOWNERS (#3659)

* Update Engine's docstring & CLI --help outputs (#3658)

Update Engine's CLI docstring & HelpFormatter

* Fix unit test for semantic segmentation to run it without mmseg (#3670)

fix test to run wo mm

* Enable ruff & ruff-format into otx/algo/classification/backbones (#3667)

* Enable ruff in otx.algo.classification.backbones

* Fix unit-test

* Fix docstring

* Disable integration test in pr-merge workflow (#3677)

* Add TV MaskRCNN Tile Recipe (#3655)

* add tv maskrcnn recipe

* add unit test

* add tile size

* fix bug

* Align integration test to exportable code interface update for release branch (#3676)

* align integration test to exportable code update

* add error message

* align vp expected output name

* Refactor exporter for anomaly task and fix a bug with exportable code (#3672)

* refactor exporter

* remove *to

* reply comments

* resolve problem with local temp file

* Fix NNCF MaskRCNN-Eff accuracy drop (#3680)

* fix nncf maskrcnn eff accuracy drop

* update ignored scope

* fix typo

* Update pandas version constraint (#3679)

---------

Co-authored-by: Yunchu Lee <yunchu.lee@intel.com>
Co-authored-by: Prokofiev Kirill <kirill.prokofiev@intel.com>
Co-authored-by: Eugene Liu <eugene.liu@intel.com>
Co-authored-by: Eunwoo Shin <eunwoo.shin@intel.com>
wonjuleee pushed a commit that referenced this pull request Jun 29, 2024
@yunchu @harimkang
@kprokofi @eugene123tw @eunwoosh @sovrasov @sungchul2 @chuneuny-emily
Mergeback 2.1.0rc0 to develop (#3694)
c51a787 
* [hotfix] Update for fix workflow issues (#3668)

* Update README & CODEOWNERS (#3659)

* Update Engine's docstring & CLI --help outputs (#3658)

Update Engine's CLI docstring & HelpFormatter

* Fix unit test for semantic segmentation to run it without mmseg (#3670)

fix test to run wo mm

* Enable ruff & ruff-format into otx/algo/classification/backbones (#3667)

* Enable ruff in otx.algo.classification.backbones

* Fix unit-test

* Fix docstring

* Disable integration test in pr-merge workflow (#3677)

* Add TV MaskRCNN Tile Recipe (#3655)

* add tv maskrcnn recipe

* add unit test

* add tile size

* fix bug

* Align integration test to exportable code interface update for release branch (#3676)

* align integration test to exportable code update

* add error message

* align vp expected output name

* Refactor exporter for anomaly task and fix a bug with exportable code (#3672)

* refactor exporter

* remove *to

* reply comments

* resolve problem with local temp file

* Fix NNCF MaskRCNN-Eff accuracy drop (#3680)

* fix nncf maskrcnn eff accuracy drop

* update ignored scope

* fix typo

* Update pandas version constraint (#3679)

* Include more models to export test into test_otx_e2e (#3678)

* enable export test

* re-enable failed models

* exclude exportable code test from anomaly task

* apply it to e2e test code

* align with pre-commit

* Fix optimize with Semi-SL data pipeline (#3684)

Disable unlabeled dataset with optimize

* Fix MaskRCNN SwinT NNCF Accuracy Drop (#3685)

fix swin-t nncf kinda

* Bump MAPI version (#3686)

* Add rotated det OV recipe (#3687)

* Add rotated det ov recipe

* fix e2e test cli

* Move assigning tasks to Models from Engine to Anomaly Model Classes (#3683)

* Move Task assign into Model with Anomaly Task

* Fix openvino model class

* Refactoring detection modules (#3636)

* Organize common functions that are located in each det model into OTXDetectionModel
    - __init__, _build_model, _create_model, _customize_inputs, _customize_outputs, get_classification_layers
* Create common directory for modules used across tasks
* Remove DictConfig to use dict instead
* Update docstring
* Refactoring
    - export related things
    - grouped importing backbones, necks, heads, losses
    - move assigners, coders, prior_generators, samplers which are located in heads to utils

* Fix segmentation fault on VPM PTQ (#3689)

Add forcing `num_workers` to 0

* Fix detection performance degradation (#3691)

Update to apply filtering to only `test_step` and `predict_step` not to affect training

* Bump datumaro to 1.7.0 (#3669)

* bump datumaro to 1.7.0

* apply changes on datumaro 1.7.0

* Add maskrcnn_r50_tv_tile (#3692)

* Update version string and fill missing changelog (#3693)

---------

Co-authored-by: Harim Kang <harim.kang@intel.com>
Co-authored-by: Prokofiev Kirill <kirill.prokofiev@intel.com>
Co-authored-by: Eugene Liu <eugene.liu@intel.com>
Co-authored-by: Eunwoo Shin <eunwoo.shin@intel.com>
Co-authored-by: Vladislav Sovrasov <sovrasov.vlad@gmail.com>
Co-authored-by: Kim, Sungchul <sungchul.kim@intel.com>
Co-authored-by: Emily Chun <emily.chun@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sungchul2 sungchul2 sungchul2 approved these changes

@eunwoosh eunwoosh eunwoosh approved these changes

@samet-akcay samet-akcay Awaiting requested review from samet-akcay samet-akcay is a code owner

@vinnamkim vinnamkim Awaiting requested review from vinnamkim

@jaegukhyun jaegukhyun Awaiting requested review from jaegukhyun

@eugene123tw eugene123tw Awaiting requested review from eugene123tw eugene123tw is a code owner

@kprokofi kprokofi Awaiting requested review from kprokofi kprokofi is a code owner

@chuneuny-emily chuneuny-emily Awaiting requested review from chuneuny-emily chuneuny-emily is a code owner

@sovrasov sovrasov Awaiting requested review from sovrasov sovrasov is a code owner

@GalyaZalesskaya GalyaZalesskaya Awaiting requested review from GalyaZalesskaya GalyaZalesskaya is a code owner

@negvet negvet Awaiting requested review from negvet negvet is a code owner

@goodsong81 goodsong81 Awaiting requested review from goodsong81 goodsong81 is a code owner

@yunchu yunchu Awaiting requested review from yunchu yunchu is a code owner

@wonjuleee wonjuleee Awaiting requested review from wonjuleee wonjuleee is a code owner

Assignees
No one assigned
Labels
CLI Any changes in OTE CLI
Projects
None yet
Milestone
2.1.0
Development

Successfully merging this pull request may close these issues.
3 participants
@harimkang @eunwoosh @sungchul2