Add explanation for XAI & minor doc fixes #1923

GalyaZalesskaya · 2023-03-21T14:15:44Z

Summary

Added explanation for XAI (explainable AI)
Updated tutorials for XAI
Added accuracy characteristics for object detector models on VOC dataset (CVS-103636)
Updates Quick Start and ReadME with XAI mention (requested by Mark)
Updated structure representation of tutorials not to expose inner headings in documents (the structure became more clean and clear comparing to current version)
Minor fixes with warnings and broken links

How to test

cd docs
make html

open build/index.html

Checklist

I submit my changes into the develop branch
I have added description of my changes into CHANGELOG
I have updated the documentation accordingly
I have added tests to cover my changes
I have linked related issues

License

I submit my code changes under the same MIT 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) 2023 Intel Corporation
#
# SPDX-License-Identifier: MIT

Updated daily workflow - remove if statement to allow running on any branch by manually

re bugfix

negvet

Thank you! It would be good to center images, although not a must

docs/source/guide/explanation/additional_features/xai.rst

docs/source/guide/tutorials/base/explain.rst

GalyaZalesskaya · 2023-03-22T11:09:18Z

@nevget Thank you for your review and clarification. All done and images were aligned to center

codecov-commenter · 2023-03-22T15:09:32Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (cd2519f) 80.70% compared to head (d63dad0) 80.70%.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #1923   +/-   ##
========================================
  Coverage    80.70%   80.70%           
========================================
  Files          489      489           
  Lines        33388    33388           
========================================
  Hits         26947    26947           
  Misses        6441     6441

Impacted Files	Coverage Δ
otx/cli/manager/config_manager.py	`84.98% <ø> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

GalyaZalesskaya · 2023-03-22T15:22:34Z

@eunwoosh I'm sorry to bother you, but can you kindly review this again?

kprokofi

Thank you for your work!
Let's add more datasets for detection as we discussed

docs/source/guide/explanation/algorithms/object_detection/object_detection.rst

kprokofi

LGTM

goodsong81

What do you think of changing the target branch to release/1.1.0?
Or, would you replicate this PR?

The base branch was changed.

GalyaZalesskaya · 2023-03-23T08:07:25Z

@goodsong81 I updated the target branch, thank you

* Bump up version to 1.1.0rc1 * Updated daily workflow (#1905) - remove if statement to allow running on any branch by manually * [FIX] Wrong test temp directory path (#1902) * Fix wrong test temp directory * Update tests/unit/algorithms/action/adapters/mmaction/utils/test_action_config_utils.py * Update test_action_config_utils.py * Update PR template (#1914) * Update . location. * Fix OTX1.1 -> Geti1.4 integration issues (#1910) * Add dill to requirements/api.txt * Return None instead of raising NotImplementedError in IMedia2DEntity.path * Move utils HPO uses into HPO directory (#1912) move utils into hpo dir * [FIX] Add stability to explain detection (#1901) Add stability to explain detection * [Fix] e2e tests FQ references (#1918) Fix FQ references * Move mpa.deploy to otx.algorithms.common (#1903) * Move deploy modules to otx * test: fix mmdeploy api replacement error * Fix pre-commit issues * Update otx/mpa/det/exporter.py * Update otx/mpa/exporter_mixin.py * Update otx/mpa/seg/exporter.py * Update otx/mpa/cls/exporter.py * Update otx/algorithms/common/adapters/mmdeploy/utils/mmdeploy.py * Update otx/algorithms/common/adapters/mmdeploy/utils/operations_domain.py * Add mmcls.VisionTransformer backbone support (#1908) * Add mmcls transformer backbones * Fix VisionTransformeroutput check * Add changes * Disable recording forward hooks in inferrer * Remove unused import * Move semantic-segmentation related codes to otx adapters (#1911) * Added security.md Add the security related notification * Update security.md fix prettier issue * Add custom exception class for CLI (#1919) * Add custom exception class for CLI * Fixed TCs for config_manager * Correct License to Apache * Remove temp hot key values (#1916) * Refactor OTX classification phase 1: move modules from MPA to OTX (#1893) * Revert TrainType typo (#1928) * Fix Conflict * Fix conflict * Fix unit-tests * Fix cli tests * Fix cli tests * Fix type * Move all hooks in MPA into OTX common mmcv adapter (#1922) * Add explanation for XAI & minor doc fixes (#1923) * [CI] Updated daily workflow (#1904) Updated daily workflow - remove if statement to allow running on any branch by manually * [FIX] re-bugfix: ATSS head loss (#1907) re bugfix * Fix typos * Explanation of Explanation * Add images & typo fixes * Fixes from comments * Add accuracy for OD explanation * Tutorial update * Add accuracy for BCCD and WGISD * Fix * Move utils to OTX common & adapter (#1931) * [CI] Updated daily workflow (#1904) Updated daily workflow - remove if statement to allow running on any branch by manually * [FIX] re-bugfix: ATSS head loss (#1907) re bugfix * Added security.md Added the security related notification. * Update security.md fix prettier issue * Move utils * Fix typo * Move classification unit tests to OTX tests (#1932) * [CI] Updated daily workflow (#1904) Updated daily workflow - remove if statement to allow running on any branch by manually * [FIX] re-bugfix: ATSS head loss (#1907) re bugfix * Added security.md Added the security related notification. * Update security.md fix prettier issue * Move classification unit tests * Apply mocker in RandAugment TC * Move otx.mpa.modules.ov -> otx.core.ov (#1929) * First Refactoring * Refactor mpa.modules.ov -> otx.core.ov * Remove otx.mpa.modules.ov * Fix docs & unit test paths * Fix some import * Add TODO comments * Add github icon link in doc head (#1934) * Fix invalid temp_dir inside unit tests (#1937) * Move all model utils and dataloaders/samplers in mpa to otx adapter (#1930) * Move stages to each algorithms (#1938) * Move stages to each algorithms * Change docs for action recognition (#1940) * Change docs for action recognition * Fix typo * Update MoViNet related parts * Add MoViNet performance * Revert table include Complexity and Model size * Fix tox to run tests on non-editable install * Fix packaging errors including cython module build / import issues (#1936) * Avoid cychon compile on Windows * Fix packaging errors * Fix pre-commit * Remove use_develop option from tox tests * Fix pre-commit * Fix tox -e -> -re for clean build * Fix import error * Add missing __init__.py * Fix relative -> absolute import * Revert to editable package in tox tests * Release 1.1.0 (#1933) * Release OTX 1.1.0 * Update known issues in CHANGELOG.md * Fix PR / issue # to links * Fix pre-commit * Bump-up version to 1.2 * Fix pre-commit --------- Signed-off-by: Songki Choi <songki.choi@intel.com> Co-authored-by: Yunchu Lee <yunchu.lee@intel.com> Co-authored-by: Harim Kang <harim.kang@intel.com> Co-authored-by: Eunwoo Shin <eunwoo.shin@intel.com> Co-authored-by: Emily Chun <emily.chun@intel.com> Co-authored-by: emily.chun <chuneuny@ikvensx012> Co-authored-by: Sungman Cho <sungman.cho@intel.com> Co-authored-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com> Co-authored-by: Jaeguk Hyun <jaeguk.hyun@intel.com> Co-authored-by: Jihwan Eom <jihwan.eom@intel.com> Co-authored-by: Soobee Lee <soobee.lee@intel.com> Co-authored-by: Galina Zalesskaya <galina.zalesskaya@intel.com>

yunchu and others added 5 commits March 17, 2023 17:46

[CI] Updated daily workflow (openvinotoolkit#1904)

40559b0

Updated daily workflow - remove if statement to allow running on any branch by manually

[FIX] re-bugfix: ATSS head loss (openvinotoolkit#1907)

cd2519f

re bugfix

Fix typos

07a8458

Explanation of Explanation

4af0c04

Add images & typo fixes

fc74550

GalyaZalesskaya added the DOC Improvements or additions to documentation label Mar 21, 2023

GalyaZalesskaya added this to the 1.1.0 milestone Mar 21, 2023

GalyaZalesskaya requested review from negvet and kprokofi March 21, 2023 14:15

GalyaZalesskaya requested a review from a team as a code owner March 21, 2023 14:15

github-actions bot added ALGO Any changes in OTX Algo Tasks implementation CLI Any changes in OTE CLI labels Mar 21, 2023

negvet requested changes Mar 21, 2023

View reviewed changes

negvet reviewed Mar 21, 2023

View reviewed changes

docs/source/guide/tutorials/base/explain.rst Outdated Show resolved Hide resolved

eunwoosh previously approved these changes Mar 22, 2023

View reviewed changes

Fixes from comments

1e245d3

GalyaZalesskaya dismissed eunwoosh’s stale review via 1e245d3 March 22, 2023 11:08

GalyaZalesskaya added 2 commits March 22, 2023 16:20

Add accuracy for OD explanation

975c38e

Tutorial update

e639a10

negvet previously approved these changes Mar 22, 2023

View reviewed changes

kprokofi reviewed Mar 22, 2023

View reviewed changes

docs/source/guide/explanation/algorithms/object_detection/object_detection.rst Show resolved Hide resolved

docs/source/guide/explanation/algorithms/object_detection/object_detection.rst Outdated Show resolved Hide resolved

Add accuracy for BCCD and WGISD

f592b09

GalyaZalesskaya dismissed negvet’s stale review via f592b09 March 22, 2023 16:06

Fix

d63dad0

kprokofi previously approved these changes Mar 22, 2023

View reviewed changes

kprokofi requested review from negvet and eunwoosh March 22, 2023 16:11

negvet previously approved these changes Mar 22, 2023

View reviewed changes

eunwoosh previously approved these changes Mar 23, 2023

View reviewed changes

goodsong81 requested changes Mar 23, 2023

View reviewed changes

GalyaZalesskaya changed the base branch from develop to releases/1.1.0 March 23, 2023 08:02

goodsong81 approved these changes Mar 23, 2023

View reviewed changes

goodsong81 merged commit 72fc455 into openvinotoolkit:releases/1.1.0 Mar 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add explanation for XAI & minor doc fixes #1923

Add explanation for XAI & minor doc fixes #1923

GalyaZalesskaya commented Mar 21, 2023 •

edited

Loading

negvet left a comment

GalyaZalesskaya commented Mar 22, 2023

codecov-commenter commented Mar 22, 2023 •

edited

Loading

GalyaZalesskaya commented Mar 22, 2023

kprokofi left a comment

kprokofi left a comment

goodsong81 left a comment

GalyaZalesskaya commented Mar 23, 2023

Add explanation for XAI & minor doc fixes #1923

Add explanation for XAI & minor doc fixes #1923

Conversation

GalyaZalesskaya commented Mar 21, 2023 • edited Loading

Summary

How to test

Checklist

License

negvet left a comment

Choose a reason for hiding this comment

GalyaZalesskaya commented Mar 22, 2023

codecov-commenter commented Mar 22, 2023 • edited Loading

Codecov Report

GalyaZalesskaya commented Mar 22, 2023

kprokofi left a comment

Choose a reason for hiding this comment

kprokofi left a comment

Choose a reason for hiding this comment

goodsong81 left a comment

Choose a reason for hiding this comment

GalyaZalesskaya commented Mar 23, 2023

GalyaZalesskaya commented Mar 21, 2023 •

edited

Loading

codecov-commenter commented Mar 22, 2023 •

edited

Loading