From 9482ed094803723e61d2404f3feef6859921db28 Mon Sep 17 00:00:00 2001 From: Yanjun Qi Date: Fri, 10 Sep 2021 11:37:26 -0400 Subject: [PATCH 1/3] correct synt error in command for optional installation --- docs/0_get_started/installation.md | 2 +- docs/1start/FAQ.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/0_get_started/installation.md b/docs/0_get_started/installation.md index 91659426..ae44894f 100644 --- a/docs/0_get_started/installation.md +++ b/docs/0_get_started/installation.md @@ -46,4 +46,4 @@ You can also install other miscallenous optional dependencies by running To install both groups of packages, run - pip install textattack[tensorflow, optional] + pip install textattack[tensorflow,optional] diff --git a/docs/1start/FAQ.md b/docs/1start/FAQ.md index 006122b9..e36a27c8 100644 --- a/docs/1start/FAQ.md +++ b/docs/1start/FAQ.md @@ -33,6 +33,12 @@ For help and realtime updates related to TextAttack, please [join the TextAttack 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: From 7266c1899e2c84665420da55556374ec1c2e3053 Mon Sep 17 00:00:00 2001 From: Yanjun Qi Date: Fri, 10 Sep 2021 11:41:51 -0400 Subject: [PATCH 2/3] Update index.rst --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 66fee3cc..24a070e3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,7 @@ TextAttack Documentation Installation <0_get_started/installation.md> Command-Line Usage <0_get_started/command_line_usage.md> Quick API Usage <0_get_started/quick_api_tour.rst> + FAQ <1start/FAQ.md> .. toctree:: :maxdepth: 6 @@ -33,7 +34,6 @@ TextAttack Documentation 1start/api-design-tips.md 1start/multilingual-visualization.md 1start/support.md - 1start/FAQ.md .. toctree:: From b66bb926eebf82ea2df75e81a1e3372a1b5c4d44 Mon Sep 17 00:00:00 2001 From: Yanjun Qi Date: Fri, 10 Sep 2021 14:02:07 -0400 Subject: [PATCH 3/3] Update requirements.txt --- docs/requirements.txt | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 024c5c4e..1ddfe961 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -9,23 +9,27 @@ sphinxcontrib-htmlhelp==2.0.0 sphinxcontrib-jsmath==1.0.1 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5 -sqlitedict==1.7.0 -stanza==1.2.2 -nbclient==0.5.3 +nbclient==0.5.4 nbconvert==6.1.0 nbformat==5.1.3 -nbsphinx==0.8.6 -ipywidgets==7.6.3 -ipykernel==6.0.3 -ipython==7.25.0 -tensorboard==2.5.0 +nbsphinx==0.8.7 +widgetsnbextension==3.5.1 +ipykernel==6.4.1 +ipython==7.27.0 +ipython-genutils==0.2.0 +ipywidgets==7.6.4 +scipy==1.7.1 +tensorboard==2.6.0 tensorboard-data-server==0.6.1 tensorboard-plugin-wit==1.8.0 tensorboardX==2.4 -tensorflow==2.5.1 -tensorflow-estimator==2.5.0 -tensorflow-text==2.4.2 +tensorflow==2.6.0 +tensorflow-estimator==2.6.0 tensorflow-hub==0.12.0 -textattack==0.3.2 -transformers==4.9.1 -pillow>=8.2.0 \ No newline at end of file +tensorflow-text==2.6.0 +sentence-transformers==2.0.0 +transformers==4.10.1 +textattack==0.3.3 +sqlitedict==1.7.0 +stanza==1.2.3 +Cython==0.29.24