Living-with-machines / DeezyMatch

A Flexible Deep Learning Approach to Fuzzy String Matching
https://living-with-machines.github.io/DeezyMatch/
Other
134 stars 34 forks source link

Improve documentation on DeezyMatch installation #100

Closed kasra-hosseini closed 2 years ago

kasra-hosseini commented 3 years ago

In the installation section, we provide different ways to install DeezyMatch. One of these methods is 2. install DeezyMatch from the source code in which a user can install DeezyMatch via:

python setup.py install

or:

pip install -v -e .

However, there is a difference between these two methods. In the latter, we use -e:

-e, --editable <path/url>   Install a project in editable mode (i.e. setuptools "develop mode")

This needs to be (briefly) explained in the documentation.

mcollardanuy commented 2 years ago

Done here.