Skip to content
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.

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

Improve documentation #654

Open
zimmerrol opened this issue Jan 28, 2022 · 7 comments
Open

Improve documentation #654

zimmerrol opened this issue Jan 28, 2022 · 7 comments

Comments

@zimmerrol
Copy link
Member

Since the current documentation lacks some important details for users and might make using foolbox harder than it has to be, we should improve this.
Let us collect suggestions for what to improve by either posting the ideas or linking the respective issues.

@zimmerrol
Copy link
Member Author

  1. Are models expected to return logits or probabilities? (e.g. CW L2 attack uses predictions instead of logits  #618)
  2. Which attacks currently exist and what modes/criteria do they support? (i.e. Attack Overview with Properties #653)

@jangop
Copy link

jangop commented Jan 28, 2022

  1. List and explain implemented criteria, and show how they are used.

labels are automagically interpreted as Misclassification, which hides the necessity and importance of criteria (see #543 (comment))

This would also solve #609.

@jangop
Copy link

jangop commented Jan 31, 2022

  1. List related projects, such as cleverhans and torchattacks.

@jangop
Copy link

jangop commented Feb 4, 2022

  1. What values are returned by attacks and what do they mean?

This is mostly about the relationship between raw adversarials and clipped adversarials. Also, what does is_adversarial relate to?

@zimmerrol
Copy link
Member Author

zimmerrol commented Feb 8, 2022

  1. How can one use the implemented attacks with sigmoid networks, i.e. there is only a single output (see Sigmoid output #664)?

@jfsullivan1
Copy link

The documentation should include what you guys have changed since foolbox 1.8.0, for example, a lot of the attack classes take different initialization and call parameters and are initialized differently in 3.x.x compared to 1.8.0. This causes issues when a user tries to run old code using foolbox 1.8.0 implementation but with the most up-to-date version of foolbox.
So, a good thing to include for attacks that have changed might be minimal examples of how to upgrade legacy foolbox usage to the most current usage.

@SerezD
Copy link
Contributor

SerezD commented Mar 22, 2024

Hi, I noticed there is a wrong link in the actual documentation at:
https://foolbox.readthedocs.io/en/stable/modules/attacks.html

The reference for InversionAttack is:

Hossein Hosseini, Baicen Xiao, Mayoore Jaiswal, Radha Poovendran, “On the Limitation of Convolutional Neural Networks in Recognizing Negative Images”, https://arxiv.org/abs/1607.02533

where the link points to the paper: "Adversarial examples in the physical world".
The correct link should be:
https://arxiv.org/abs/1703.06857

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants