qdata / textattack-webdemo

TextAttack Web Demo

TextAttack Web Demo

Setup

Prior to starting, make sure you have > Python 3.6 installed on your machine with the latest version of pip

First Time Setup and Installation

1. git clone <repo_url>
2. cd TextAttack-WebDemo
3. python3 -m venv venv to initialize the virtual environment
4. source venv/bin/activate [on MAC] or source venv/Scripts/activate [on WINDOWS] in order to activate the virtual environment
5. pip install -r requirements.txt to install the dependencies
   1. This process may fail on windows with ModuleNotFoundError: No module named 'tools.nnwrap', in this case, run the following command and then rerun the pip install of requirements.txt: pip install torch===1.4.0 torchvision===0.5.0 -f https://download.pytorch.org/whl/torch_stable.html

Running the Web App

1. python3 manage.py migrate in order to initialize any database and models changes locally with sqlite
2. python3 manage.py runserver to create an instance of the server on your local machine
3. Visit localhost:8000 in order to view the web application

Debugging

If the runserver command fails, it is most likely a database issue. In this case, please refer to the following docs for help https://docs.djangoproject.com/en/3.1/topics/migrations/.

textattack-webdemo's Issues

Trying to run the webserver fails with `module 'textattack.commands' has no attribute 'attack'`

As title says.

I'm using Python 3.10.4 and running python manae.py runserver after doing the installation of all of the requirements.

Installation fails with "python setup.py egg_info" when

When installing the requirements via "pip install -r requirements.txt" after activating the venv, I get the below error.

I was able to fix it following the advice of https://stackoverflow.com/questions/35104097/how-to-install-psycopg2-with-pg-config-error, but it'd be handy if it worked "out of the box", e.g. if this could be added as a dependency.

Collecting psycopg2-binary==2.8.5
  Downloading psycopg2-binary-2.8.5.tar.gz (381 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 381.7/381.7 KB 9.3 MB/s eta 0:00:00
  Preparing metadata (setup.py) ... error
  error: subprocess-exited-with-error
  × python setup.py egg_info did not run successfully.
  │ exit code: 1
  ╰─> [23 lines of output]
      running egg_info
      creating /tmp/pip-pip-egg-info-vkrr4ivr/psycopg2_binary.egg-info
      writing /tmp/pip-pip-egg-info-vkrr4ivr/psycopg2_binary.egg-info/PKG-INFO
      writing dependency_links to /tmp/pip-pip-egg-info-vkrr4ivr/psycopg2_binary.egg-info/dependency_links.txt
      writing top-level names to /tmp/pip-pip-egg-info-vkrr4ivr/psycopg2_binary.egg-info/top_level.txt
      writing manifest file '/tmp/pip-pip-egg-info-vkrr4ivr/psycopg2_binary.egg-info/SOURCES.txt'
      Error: pg_config executable not found.
      pg_config is required to build psycopg2 from source.  Please add the directory
      containing pg_config to the $PATH or specify the full executable path with the
      option:
          python setup.py build_ext --pg-config /path/to/pg_config build ...
      or with the pg_config option in 'setup.cfg'.
      If you prefer to avoid building psycopg2 from source, please install the PyPI
      'psycopg2-binary' package instead.
      For further information please check the 'doc/src/install.rst' file (also at
      <https://www.psycopg.org/docs/install.html>).
      [end of output]
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed
× Encountered error while generating package metadata.
╰─> See above for output.
note: This is an issue with the package mentioned above, not pip.
hint: See above for details.

Missing Dependencies

There are some missing dependencies in the requirements.txt:

• Seaborn (required to run the web server via python manage.py runserver)
• TextAttack itself (same command to reproduce. You also need to install cmake to have sentencepiece install correctly.)