Skip to content

Commit

Permalink
Fix pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
goodsong81 committed Jul 9, 2024
1 parent 997c2e3 commit 0dad132
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
6 changes: 6 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,15 @@ MD013: false
# This is not useful for some files such as `CHANGELOG.md`
MD024: false # Multiple headers with the same content

# no-blanks-blockquote Blank line inside blockquote
MD028: false

# blanks-around-fences - Fenced code blocks should be surrounded by blank lines
MD031: false

# blanks-around-lists Lists should be surrounded by blank lines
MD032: false

# I find it necessary to use '<br/>' to force line breaks.
MD033: false # Inline HTML

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@ import openvino_xai as xai

explainer = xai.Explainer(model=ov_model, task=xai.Task.CLASSIFICATION)

# Existing inference pipeline
for i, image in enumerate(images):
labels = infer(model=ov_model, image=image)

# Model analysis
explanation = explainer(data=image, targets=labels)
explanation.save(dir_path="./xai", name=str(i))
```
Expand Down Expand Up @@ -83,8 +85,8 @@ Please refer to the following known issues for unsupported models and reasons.
* [Models not supported by white box XAI methods (#30)](https://github.com/openvinotoolkit/openvino_xai/issues/30)

> **_WARNING:_** OpenVINO XAI is fully validated on OpenVINO 2024.2.0. Following issue might be observed if used with older versions of OpenVINO.
[OpenVINO IR branch insertion not working for models converted directly from torch models with OVC (#26)](https://github.com/openvinotoolkit/openvino_xai/issues/26)
A simple workaround is to convert Torch models to ONNX models and then convert to OpenVINO models to feed to OpenVINO XAI. Please refer to [the code example](openvino_xai/utils/model_export.py).
> * [OpenVINO IR branch insertion not working for models converted directly from torch models with OVC (#26)](https://github.com/openvinotoolkit/openvino_xai/issues/26)
> A simple workaround is to convert Torch models to ONNX models and then convert to OpenVINO models to feed to OpenVINO XAI. Please refer to [the code example](openvino_xai/utils/model_export.py).
> **_NOTE:_** GenAI / LLMs would be also supported incrementally in the upcoming releases.
Expand Down

0 comments on commit 0dad132

Please sign in to comment.