Skip to content

Commit

Permalink
Merge pull request #535 from QData/install-doc-minor
Browse files Browse the repository at this point in the history
Update installation.md to add FAQ on installation
  • Loading branch information
qiyanjun committed Oct 1, 2021
2 parents 7d2de08 + 748990a commit 0f6401d
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/0_get_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,34 @@ You can also install other miscallenous optional dependencies by running
To install both groups of packages, run

pip install textattack[tensorflow,optional]



## FAQ on installation

For many of the dependent library issues, the following command is the first you could try:
```bash
pip install --force-reinstall textattack
```

OR
```bash
pip install textattack[tensorflow,optional]
```


Besides, we highly recommend you to use virtual environment for textattack use,
see [information here](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#removing-an-environment). Here is one conda example:

```bash
conda create -n textattackenv python=3.7
conda activate textattackenv
conda env list
```

If you want to use the most-up-to-date version of textattack (normally with newer bug fixes), you can run the following:
```bash
git clone https://github.com/QData/TextAttack.git
cd TextAttack
pip install .[dev]
```

0 comments on commit 0f6401d

Please sign in to comment.