openvinotoolkit / openvino_xai

OpenVINO™ Explainable AI (XAI) Toolkit: Visual Explanation for OpenVINO Models
https://openvinotoolkit.github.io/openvino_xai/
Apache License 2.0
28 stars 9 forks source link

Add method documentation #63

Closed negvet closed 1 month ago

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.29%. Comparing base (f637a5f) to head (2a29cb3). Report is 3 commits behind head on releases/1.1.0.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## releases/1.1.0 #63 +/- ## ================================================== + Coverage 93.65% 94.29% +0.64% ================================================== Files 26 27 +1 Lines 1638 1857 +219 ================================================== + Hits 1534 1751 +217 - Misses 104 106 +2 ``` | [Flag](https://app.codecov.io/gh/openvinotoolkit/openvino_xai/pull/63/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=openvinotoolkit) | Coverage Δ | | |---|---|---| | [dev-py310](https://app.codecov.io/gh/openvinotoolkit/openvino_xai/pull/63/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=openvinotoolkit) | `94.29% <ø> (+0.64%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=openvinotoolkit#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

negvet commented 1 month ago

Hmm, it might be semantically a subsection of the user guide.

This is a good suggestion, I followed it. Initially, I assumed that it might be too big, but probably it is fine.