ARES2.0 DOCS

thu-ml · Sep 26, 2023 · 51e58f0 · 51e58f0
1 parent 9ff5961
commit 51e58f0
Show file tree

Hide file tree

Showing 110 changed files with 1,528 additions and 0 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 53c2bb3aab348af15e0259e3f9235d6b
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_modules/ares/attack/autoattack/autoattack.html b/docs/_modules/ares/attack/autoattack/autoattack.html
diff --git a/docs/_modules/ares/attack/bim.html b/docs/_modules/ares/attack/bim.html
diff --git a/docs/_modules/ares/attack/boundary.html b/docs/_modules/ares/attack/boundary.html
diff --git a/docs/_modules/ares/attack/cw.html b/docs/_modules/ares/attack/cw.html
diff --git a/docs/_modules/ares/attack/deepfool.html b/docs/_modules/ares/attack/deepfool.html
diff --git a/docs/_modules/ares/attack/detection/attacker.html b/docs/_modules/ares/attack/detection/attacker.html
diff --git a/docs/_modules/ares/attack/detection/custom/coco_dataset.html b/docs/_modules/ares/attack/detection/custom/coco_dataset.html
diff --git a/docs/_modules/ares/attack/detection/custom/coco_metric.html b/docs/_modules/ares/attack/detection/custom/coco_metric.html
diff --git a/docs/_modules/ares/attack/detection/custom/detector.html b/docs/_modules/ares/attack/detection/custom/detector.html
diff --git a/docs/_modules/ares/attack/detection/custom/lr_scheduler.html b/docs/_modules/ares/attack/detection/custom/lr_scheduler.html
diff --git a/docs/_modules/ares/attack/detection/patch/patch_applier.html b/docs/_modules/ares/attack/detection/patch/patch_applier.html
diff --git a/docs/_modules/ares/attack/detection/patch/patch_transform.html b/docs/_modules/ares/attack/detection/patch/patch_transform.html
diff --git a/docs/_modules/ares/attack/detection/trainer.html b/docs/_modules/ares/attack/detection/trainer.html
diff --git a/docs/_modules/ares/attack/detection/utils.html b/docs/_modules/ares/attack/detection/utils.html
diff --git a/docs/_modules/ares/attack/di_fgsm.html b/docs/_modules/ares/attack/di_fgsm.html
diff --git a/docs/_modules/ares/attack/evolutionary.html b/docs/_modules/ares/attack/evolutionary.html
diff --git a/docs/_modules/ares/attack/fgsm.html b/docs/_modules/ares/attack/fgsm.html
diff --git a/docs/_modules/ares/attack/mim.html b/docs/_modules/ares/attack/mim.html
diff --git a/docs/_modules/ares/attack/nattack.html b/docs/_modules/ares/attack/nattack.html
diff --git a/docs/_modules/ares/attack/nes.html b/docs/_modules/ares/attack/nes.html
diff --git a/docs/_modules/ares/attack/si_ni_fgsm.html b/docs/_modules/ares/attack/si_ni_fgsm.html
diff --git a/docs/_modules/ares/attack/spsa.html b/docs/_modules/ares/attack/spsa.html
diff --git a/docs/_modules/ares/attack/tim.html b/docs/_modules/ares/attack/tim.html
diff --git a/docs/_modules/ares/attack/tta.html b/docs/_modules/ares/attack/tta.html
diff --git a/docs/_modules/ares/attack/vmi_fgsm.html b/docs/_modules/ares/attack/vmi_fgsm.html
diff --git a/docs/_modules/ares/dataset/cifar_dataset.html b/docs/_modules/ares/dataset/cifar_dataset.html
diff --git a/docs/_modules/ares/dataset/imagenet_dataset.html b/docs/_modules/ares/dataset/imagenet_dataset.html
diff --git a/docs/_modules/ares/defense/bit_depth_reduction.html b/docs/_modules/ares/defense/bit_depth_reduction.html
diff --git a/docs/_modules/ares/defense/jpeg_compression.html b/docs/_modules/ares/defense/jpeg_compression.html
diff --git a/docs/_modules/ares/defense/randomization.html b/docs/_modules/ares/defense/randomization.html
diff --git a/docs/_modules/ares/model/cifar10_cls.html b/docs/_modules/ares/model/cifar10_cls.html
diff --git a/docs/_modules/ares/model/imagenet_cls.html b/docs/_modules/ares/model/imagenet_cls.html
diff --git a/docs/_modules/ares/model/preact_resnet.html b/docs/_modules/ares/model/preact_resnet.html
diff --git a/docs/_modules/ares/model/resnet.html b/docs/_modules/ares/model/resnet.html
diff --git a/docs/_modules/ares/model/resnet_denoise.html b/docs/_modules/ares/model/resnet_denoise.html
diff --git a/docs/_modules/ares/model/vit_mae.html b/docs/_modules/ares/model/vit_mae.html
diff --git a/docs/_modules/ares/model/wideresnet.html b/docs/_modules/ares/model/wideresnet.html
diff --git a/docs/_modules/ares/utils/adv.html b/docs/_modules/ares/utils/adv.html
diff --git a/docs/_modules/ares/utils/dataset.html b/docs/_modules/ares/utils/dataset.html
diff --git a/docs/_modules/ares/utils/dist.html b/docs/_modules/ares/utils/dist.html
diff --git a/docs/_modules/ares/utils/logger.html b/docs/_modules/ares/utils/logger.html
diff --git a/docs/_modules/ares/utils/loss.html b/docs/_modules/ares/utils/loss.html
diff --git a/docs/_modules/ares/utils/metrics.html b/docs/_modules/ares/utils/metrics.html
diff --git a/docs/_modules/ares/utils/model.html b/docs/_modules/ares/utils/model.html
diff --git a/docs/_modules/ares/utils/registry.html b/docs/_modules/ares/utils/registry.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
diff --git a/docs/_sources/api/ares.attack.rst.txt b/docs/_sources/api/ares.attack.rst.txt
diff --git a/docs/_sources/api/ares.dataset.rst.txt b/docs/_sources/api/ares.dataset.rst.txt
diff --git a/docs/_sources/api/ares.defense.rst.txt b/docs/_sources/api/ares.defense.rst.txt
diff --git a/docs/_sources/api/ares.detection.rst.txt b/docs/_sources/api/ares.detection.rst.txt
diff --git a/docs/_sources/api/ares.model.rst.txt b/docs/_sources/api/ares.model.rst.txt
diff --git a/docs/_sources/api/ares.utils.rst.txt b/docs/_sources/api/ares.utils.rst.txt
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
diff --git a/docs/_sources/tutorial/attack_classification.rst.txt b/docs/_sources/tutorial/attack_classification.rst.txt
diff --git a/docs/_sources/tutorial/attack_detection.rst.txt b/docs/_sources/tutorial/attack_detection.rst.txt
diff --git a/docs/_sources/tutorial/robust_training.rst.txt b/docs/_sources/tutorial/robust_training.rst.txt
diff --git a/docs/_static/_sphinx_javascript_frameworks_compat.js b/docs/_static/_sphinx_javascript_frameworks_compat.js
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
diff --git a/docs/_static/css/badge_only.css b/docs/_static/css/badge_only.css
diff --git a/docs/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/_static/css/fonts/Roboto-Slab-Bold.woff
diff --git a/docs/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/_static/css/fonts/Roboto-Slab-Bold.woff2
diff --git a/docs/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/_static/css/fonts/Roboto-Slab-Regular.woff
diff --git a/docs/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/_static/css/fonts/Roboto-Slab-Regular.woff2
diff --git a/docs/_static/css/fonts/fontawesome-webfont.eot b/docs/_static/css/fonts/fontawesome-webfont.eot
diff --git a/docs/_static/css/fonts/fontawesome-webfont.svg b/docs/_static/css/fonts/fontawesome-webfont.svg
diff --git a/docs/_static/css/fonts/fontawesome-webfont.ttf b/docs/_static/css/fonts/fontawesome-webfont.ttf
diff --git a/docs/_static/css/fonts/fontawesome-webfont.woff b/docs/_static/css/fonts/fontawesome-webfont.woff
diff --git a/docs/_static/css/fonts/fontawesome-webfont.woff2 b/docs/_static/css/fonts/fontawesome-webfont.woff2
diff --git a/docs/_static/css/fonts/lato-bold-italic.woff b/docs/_static/css/fonts/lato-bold-italic.woff
diff --git a/docs/_static/css/fonts/lato-bold-italic.woff2 b/docs/_static/css/fonts/lato-bold-italic.woff2
diff --git a/docs/_static/css/fonts/lato-bold.woff b/docs/_static/css/fonts/lato-bold.woff
diff --git a/docs/_static/css/fonts/lato-bold.woff2 b/docs/_static/css/fonts/lato-bold.woff2
diff --git a/docs/_static/css/fonts/lato-normal-italic.woff b/docs/_static/css/fonts/lato-normal-italic.woff
diff --git a/docs/_static/css/fonts/lato-normal-italic.woff2 b/docs/_static/css/fonts/lato-normal-italic.woff2
diff --git a/docs/_static/css/fonts/lato-normal.woff b/docs/_static/css/fonts/lato-normal.woff
diff --git a/docs/_static/css/fonts/lato-normal.woff2 b/docs/_static/css/fonts/lato-normal.woff2
diff --git a/docs/_static/css/theme.css b/docs/_static/css/theme.css
diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
diff --git a/docs/_static/file.png b/docs/_static/file.png
diff --git a/docs/_static/jquery-3.6.0.js b/docs/_static/jquery-3.6.0.js
diff --git a/docs/_static/jquery.js b/docs/_static/jquery.js
diff --git a/docs/_static/js/badge_only.js b/docs/_static/js/badge_only.js
diff --git a/docs/_static/js/html5shiv-printshiv.min.js b/docs/_static/js/html5shiv-printshiv.min.js
diff --git a/docs/_static/js/html5shiv.min.js b/docs/_static/js/html5shiv.min.js
diff --git a/docs/_static/js/theme.js b/docs/_static/js/theme.js
diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js
diff --git a/docs/_static/minus.png b/docs/_static/minus.png
diff --git a/docs/_static/plus.png b/docs/_static/plus.png
diff --git a/docs/_static/pygments.css b/docs/_static/pygments.css
diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
diff --git a/docs/_static/underscore-1.13.1.js b/docs/_static/underscore-1.13.1.js
diff --git a/docs/_static/underscore.js b/docs/_static/underscore.js
diff --git a/docs/api/ares.attack.html b/docs/api/ares.attack.html
diff --git a/docs/api/ares.dataset.html b/docs/api/ares.dataset.html
@@ -0,0 +1,151 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>ares.dataset package &mdash; ARES 2.0 documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script src="../_static/doctools.js"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="ares.model package" href="ares.model.html" />
+    <link rel="prev" title="ares.defense package" href="ares.defense.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            ARES
+          </a>
+              <div class="version">
+                2.0.0
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../tutorial/attack_classification.html">Attacking Image Classification Models</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorial/attack_detection.html">Attacking Object Detection Models</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorial/robust_training.html">Robust Training for Image Classification</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API Docs</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="ares.attack.html">ares.attack package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ares.detection.html">ares.attack.detection package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ares.defense.html">ares.defense package</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">ares.dataset package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ares.model.html">ares.model package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ares.utils.html">ares.utils package</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">ARES</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">ares.dataset package</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="../_sources/api/ares.dataset.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="module-ares.dataset.cifar_dataset">
+<span id="ares-dataset-package"></span><h1>ares.dataset package<a class="headerlink" href="#module-ares.dataset.cifar_dataset" title="Permalink to this heading">¶</a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="ares.dataset.cifar_dataset.cifar10">
+<span class="sig-prename descclassname"><span class="pre">ares.dataset.cifar_dataset.</span></span><span class="sig-name descname"><span class="pre">cifar10</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batchsize</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cifar10_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ares/dataset/cifar_dataset.html#cifar10"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ares.dataset.cifar_dataset.cifar10" title="Permalink to this definition">¶</a></dt>
+<dd><p>The function to create cifar10 dataloader.</p>
+</dd></dl>
+
+<span class="target" id="module-ares.dataset.imagenet_dataset"></span><dl class="py class">
+<dt class="sig sig-object py" id="ares.dataset.imagenet_dataset.ImageNetDataset">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ares.dataset.imagenet_dataset.</span></span><span class="sig-name descname"><span class="pre">ImageNetDataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_dir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meta_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transform</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ares/dataset/imagenet_dataset.html#ImageNetDataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ares.dataset.imagenet_dataset.ImageNetDataset" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Dataset</span></code></p>
+<p>The class to create ImageNet dataset.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="ares.dataset.imagenet_dataset.ImageNetDataset.__init__">
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_dir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meta_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transform</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ares/dataset/imagenet_dataset.html#ImageNetDataset.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ares.dataset.imagenet_dataset.ImageNetDataset.__init__" title="Permalink to this definition">¶</a></dt>
+<dd><p>The function to initialize ImageNet class.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>data_dir</strong> (<em>str</em>) – The path to the dataset.</p></li>
+<li><p><strong>meta_file</strong> (<em>str</em>) – The path to the file containing image directories and labels.</p></li>
+<li><p><strong>transform</strong> (<em>torchvision.transforms</em>) – The transform for input image.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="ares.defense.html" class="btn btn-neutral float-left" title="ares.defense package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="ares.model.html" class="btn btn-neutral float-right" title="ares.model package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, ARES 2.0 contributors.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>