Welcome to ARES's documentation!
====================================

Installation
------------

Before start, please first install ARES 2.0 as follows:

- Initialize a dedicated environment for ARES 2.0.

.. code-block:: bash

   conda create -n ares python==3.10.9
   conda activate ares

- Clone and setup:

.. code-block:: bash

   git clone https://github.com/thu-ml/ares2.0
   cd ares2.0
   pip install -r requirements.txt
   mim install mmengine==0.8.4
   mim install mmcv==2.0.0
   mim install mmdet==3.1.0
   pip install -v -e .


.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   tutorial/attack_classification
   tutorial/attack_detection
   tutorial/robust_training

.. toctree::
   :maxdepth: 1
   :caption: API Docs

   api/ares.attack
   api/ares.detection
   api/ares.defense
   api/ares.dataset
   api/ares.model

   api/ares.utils

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`