% HEART-library documentation master file, created by % sphinx-quickstart on Wed Mar 27 15:42:18 2024. % You can adapt this file completely to your liking, but it should at least % contain the root `toctree` directive. ::::{grid} 2 :::{grid-item} :child-align: center # HEART-library Documentation The **Hardened Extension of the Adversarial Robustness Toolkit (HEART)** is a modular open-source Python library that provides AI developers and researchers with Testing and Evaluation (T&E) tools to assess AI model performance under adversarial attacks and improve model resiliency. ```{button-link} quick_start/install_heart.html :color: primary :shadow: Get Started with HEART {octicon}`arrow-right` ``` ::: :::{grid-item} :child-align: end :columns: 6 ```{image} _static/theme/4x/HEART-Hero-Cycle_2@4x.png :alt: HEART Hero Image :class: only-light ``` ```{image} _static/theme/4x/HEART-Hero-Cycle_2-dark@4x.png :alt: HEART Hero Image :class: only-dark ``` ::: :::: --- ::::::{grid} 2 :::::{grid-item-card} Quick Start ::::{grid} 2 :::{grid-item} :columns: 3 ```{image} _static/theme/SVG/quick-start.svg :alt: Quick Start :class: only-light :target: quick_start/install_heart.html ``` ```{image} _static/theme/SVG/quick-start-dark.svg :alt: Quick Start :class: only-dark :target: quick_start/install_heart.html ``` ::: :::{grid-item} :columns: 9 Use these resources to get an introduction to HEART and install the library ::: :::{grid-item} :class: home-tile-link-list :columns: 12 - [Introduction to HEART](quick_start/intro_heart.md) - [Installation and Setup](quick_start/install_heart.md) ::: :::: ::::: :::::{grid-item-card} Tutorials ::::{grid} 2 :::{grid-item} :columns: 3 ```{image} _static/theme/SVG/tutorial.svg :alt: Sylized icon depicting an instructor teaching an audience. :class: only-light :target: tutorials/index.html ``` ```{image} _static/theme/SVG/tutorial-dark.svg :alt: Sylized icon depicting an instructor teaching an audience. :class: only-dark :target: tutorials/index.html ``` ::: :::{grid-item} :columns: 9 If you are new to AI Security, the tutorials will introduce you to key concepts and workflows ::: :::{grid-item} :class: home-tile-link-list :columns: 12 - [Drone Object Detection](tutorials/drone_tutorial/index.md) ::: :::: ::::: :::::: ::::::{grid} 2 :::::{grid-item-card} How-to Guides ::::{grid} 2 :::{grid-item} :columns: 3 ```{image} _static/theme/SVG/How-to.svg :alt: Stylized icon depicting a sheet of paper containing a checklist. :class: only-light :target: how_to_guides/index.html ``` ```{image} _static/theme/SVG/How-to-dark.svg :alt: Stylized icon depicting a sheet of paper containing a checklist. :class: only-dark :target: how_to_guides/index.html ``` ::: :::{grid-item} :columns: 9 If you are familiar with AI Security and know what you want to do, the how-to guides will show you step-by-step how to do it with HEART tools ::: :::{grid-item} :class: home-tile-link-list :columns: 12 - [Object Detection How-to Guides](how_to_guides/object_detection/index.md) - [Image Classification How-to Guides](how_to_guides/image_classification/index.md) ::: :::: ::::: :::::{grid-item-card} Explanations ::::{grid} 2 :::{grid-item} :columns: 3 ```{image} _static/theme/SVG/explanation.svg :alt: Stylized icon depicting a hand holding descriptive documents. :class: only-light :target: explanations/index.html ``` ```{image} _static/theme/SVG/explanation-dark.svg :alt: Stylized icon depicting a hand holding descriptive documents. :class: only-dark :target: explanations/index.html ``` ::: :::{grid-item} :columns: 9 The explanations provide in-depth descriptions of relevant technical concepts ::: :::{grid-item} :class: home-tile-link-list :columns: 12 - [Attack Types](explanations/attack_types.md) - [Evaluation Metrics](explanations/evaluation_metrics.md) - [Overview - Creating Adversarial Patches](explanations/PatchDocumentation.md) ```{button-link} explanations/index.html See all {octicon}`arrow-right` ::: :::: ::::: :::::: ::::::{grid} 2 :::::{grid-item-card} Reference Materials ::::{grid} 2 :::{grid-item} :columns: 3 ```{image} _static/theme/SVG/reference.svg :alt: Stylized icon depicting a grouping of informational books. :class: only-light :target: reference_materials/index.html ``` ```{image} _static/theme/SVG/reference-dark.svg :alt: Stylized icon depicting a grouping of informational books. :class: only-dark :target: reference_materials/index.html ``` ::: :::{grid-item} :columns: 9 Reference Materials provide further resources for your understanding of both AI Security concepts and HEART tools ::: :::{grid-item} :class: home-tile-link-list :columns: 12 - [Attack Cards](reference_materials/attack_cards/index.md) - [Evaluation Pathways](reference_materials/evaluation_pathways.md) - [Modules](modules/index.md) ::: :::: ::::: :::::{grid-item-card} About HEART ::::{grid} 2 :::{grid-item} :columns: 3 ```{image} _static/theme/SVG/about.svg :alt: Stylized icon with a version of the HEART-library logo, a shield with a heart. :class: only-light :target: about/contributors.html ``` ```{image} _static/theme/SVG/about-dark.svg :alt: Stylized icon with a version of the HEART-library logo, a shield with a heart. :class: only-dark :target: about/contributors.html ``` ::: :::{grid-item} :columns: 9 Learn more about HEART, its background, mission, and contributors ::: :::{grid-item} :class: home-tile-link-list :columns: 12 - [Contributors](about/contributors.md) - [Legal](legal.md) ::: :::: ::::: :::::: --- ::::{grid} 1 :::{grid-item} :child-align: center **Acknowledgement** This material is based upon work supported by the Chief Digital and Artificial Intelligence Office under Contract No. W519TC-23-9-2037. The views and conclusions contained herein are those of the author(s) and should not be interpreted as necessarily representing the official policies or endorsements, either expressed or implied, of the U.S. Government. ::: :::: ```{toctree} :caption: 'Quick Start' :maxdepth: 2 :hidden: Introduction to HEART Installation and Setup ``` ```{toctree} :caption: 'Documentation' :maxdepth: 3 :hidden: Tutorials How-to Guides Explanations Reference Materials Glossary ``` ```{toctree} :caption: 'About HEART' :maxdepth: 2 :hidden: Contributors Legal ```