diff --git a/.markdownlint.yaml b/.markdownlint.yaml index dc90ea4d..e4d05fb0 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -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 '
' to force line breaks. MD033: false # Inline HTML diff --git a/README.md b/README.md index d69c876f..670df1b4 100644 --- a/README.md +++ b/README.md @@ -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)) ``` @@ -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.