Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewilyas committed Aug 21, 2019
1 parent d0f3f56 commit 9c9d1ff
Showing 1 changed file with 11 additions and 22 deletions.
33 changes: 11 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,17 @@ demonstrate how to use the library in a set of walkthroughs and our API
reference. Functionality provided by the library includes:

- Training and evaluating standard and robust models for a variety of
datasets/architectures using a :doc:`CLI interface
<example_usage/cli_usage>`. The library also provides support for adding
:doc:`custom datasets and model architectures
<example_usage/training_lib_part_2#TODO>`.
datasets/architectures using a `CLI interface
<https://robustness.readthedocs.io/en/latest/example_usage/cli_usage.html>`_. The library also provides support for adding
`custom datasets <https://robustness.readthedocs.io/en/latest/example_usage/training_lib_part_2.html#training-on-custom-datasets>`_ and `model architectures <https://robustness.readthedocs.io/en/latest/example_usage/training_lib_part_2.html#training-with-custom-architectures>`_.

.. code-block:: bash
python -m robustness.main --dataset cifar --data /path/to/cifar \
--adv-train 0 --arch resnet18 --out-dir /logs/checkpoints/dir/
- Performing :doc:`input manipulation
<example_usage/input_space_manipulation>` using robust (or standard)
- Performing `input manipulation
<https://robustness.readthedocs.io/en/latest/example_usage/input_space_manipulation.html>`_ using robust (or standard)
models---this includes making adversarial examples, inverting representations,
feature visualization, etc. The library offers a variety of optimization
options (e.g. choice between real/estimated gradients, Fourier/pixel basis,
Expand Down Expand Up @@ -60,8 +59,9 @@ reference. Functionality provided by the library includes:
- Importing :samp:`robustness` as a package, which allows for easy training of
neural networks with support for custom loss functions, logging, data loading,
and more! A good introduction can be found in :doc:`this walkthrough
<example_usage/use_as_training_lib>`.
and more! A good introduction can be found in our two-part walkthrough
(`Part 1 <https://robustness.readthedocs.io/en/latest/example_usage/training_lib_part_1.html>`_,
`Part 2 <https://robustness.readthedocs.io/en/latest/example_usage/training_lib_part_2.html>`_).

.. code-block:: python
Expand Down Expand Up @@ -115,22 +115,11 @@ follows:
url={git.io/robustness-lib}
}
Walkthroughs
------------
Documentation
--------------
`https://robustness.readthedocs.io/en/latest/index.html`_

.. toctree::
example_usage/cli_usage
example_usage/input_space_manipulation
example_usage/use_as_training_lib

API Reference
-------------

We provide an API reference where we discuss the role of each module and
provide extensive documentation.

.. toctree::
api

.. [EIS+19] Engstrom L., Ilyas A., Santurkar S., Tsipras D., Tran B., Madry A. (2019). Learning Perceptually-Aligned Representations via Adversarial Robustness. arXiv, arXiv:1906.00945
Expand Down

0 comments on commit 9c9d1ff

Please sign in to comment.