From c06505a5b44b8ac9d24af7c3306a6f9c88279e24 Mon Sep 17 00:00:00 2001 From: Diego Miguel Lozano <22967053+dmlls@users.noreply.github.com> Date: Tue, 7 Nov 2023 10:49:25 +0100 Subject: [PATCH] Update installation.md --- docs/0_get_started/installation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/0_get_started/installation.md b/docs/0_get_started/installation.md index 911c1398..5a532cb0 100644 --- a/docs/0_get_started/installation.md +++ b/docs/0_get_started/installation.md @@ -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] @@ -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] -``` \ No newline at end of file +```