Skip to content

Commit

Permalink
Update installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dmlls authored Nov 7, 2023
1 parent da97c74 commit c06505a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/0_get_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ This installs additional dependencies required for development.


## Optional Dependencies
For quick installation, TextAttack only installs esssential packages as dependencies (e.g. Transformers, PyTorch). However, you might need to install additional packages to run certain attacks or features.
For quick installation, TextAttack only installs essential packages as dependencies (e.g. Transformers, PyTorch). However, you might need to install additional packages to run certain attacks or features.
For example, Tensorflow and Tensorflow Hub are required to use the TextFooler attack, which was proposed in [Is BERT Really Robust? A Strong Baseline for Natural Language Attack on Text Classification and Entailment](https://arxiv.org/abs/1907.11932) by Di Jin, Zhijing Jin, Joey Tianyi Zhou, and Peter Szolov.

If you attempting to use a feature that requires additional dependencies, TextAttack will let you know which ones you need to install.
If you are attempting to use a feature that requires additional dependencies, TextAttack will let you know which ones you need to install.

However, during installation step, you can also install them together with TextAttack.
You can install Tensorflow and its related packages by running

pip install textattack[tensorflow]

You can also install other miscallenous optional dependencies by running
You can also install other miscellaneous optional dependencies by running

pip install textattack[optional]

Expand Down Expand Up @@ -77,4 +77,4 @@ If you want to use the most-up-to-date version of textattack (normally with newe
git clone https://github.com/QData/TextAttack.git
cd TextAttack
pip install .[dev]
```
```

0 comments on commit c06505a

Please sign in to comment.