Skip to content

Add huggingface report template #1656

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

Merged
merged 4 commits into from
Dec 8, 2023
Merged

Add huggingface report template #1656

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ba5ac2
add huggingface report template
cy-moi Dec 4, 2023
d2df114
keep only the report and add colors for hint
cy-moi Dec 6, 2023
db552a6
change yellow to orange for clarity
cy-moi Dec 6, 2023
1d34591
Merge branch 'main' into GSK-2270-add-hf-scan-report-template
Inokinoki Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions giskard/visualization/templates/scan_report/markdown/huggingface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{% for view in groups -%}
<details>
<summary>👉{{ view.group.name }} issues ({{ view.issues|length }})</summary>

{% for issue in view.issues -%}

| Vulnerability | Level | Data slice | Metric | Transformation | Deviation |
|---------------|-------|------------|--------|----------------|-----------|
| {{ view.group.name }} | <span style="color:{% if issue.level.value == "major" %} red {% else %} orange {% endif %} "> {{ issue.level.value }} {% if issue.level.value == "major" %} 🔴 {% else %} 🟡 {% endif %} </span> | {{ issue.slicing_fn if issue.slicing_fn else "—" }} | {% if "metric" in issue.meta %}{{ issue.meta.metric }} = {{ issue.meta.metric_value|format_metric }}{% else %} "—" {% endif %} | {{ issue.transformation_fn if issue.transformation_fn else "—" }} | {{ issue.meta["deviation"] if "deviation" in issue.meta else "—" }} |

<details>
<summary> 🔍✨Examples</summary>
{{ issue.description }}

{% if issue.examples(3)|length %}
{{ issue.examples(issue.meta.num_examples if "num_examples" in issue.meta else 3).to_markdown(
index=not issue.meta.hide_index if "hide_index" in issue.meta
else True)|replace("\\n", "<br>")|safe }}
{% endif %}
</details>

{% endfor %}

</details>
{% endfor -%}
<br />