Download and installation

Selecting the right Python version

Pipeline-diacritizer was written to work under a Python 3 interpreter. However, since this tool depends on specific versions of Tensorflow and Numpy, it should run only under Python versions priors to 3.8 and no less than 3.4. It is recommended to use Python 3.7.x for this tool.

Creating a virtual environment

Firstly, a Python virtual environment should be created and activated before trying to install pipeline_diacritizer, in order to avoid any dependencies conflict.

$ python3 -m venv pipeline_diacritizer_env/
$ source pipeline_diacritizer_env/bin/activate  # You should run pipeline_diacritizer_env\Scripts\activate.bat if you are on Windows.
(pipeline_diacritizer_env) $

Installation using pip

Replicate the environment (recommended)

To ensure the correct execution of our tool, it is recommended that you replicate the exact environment using the same packages and versions before installing it. This can be done using the following command.

(pipeline_diacritizer_env) $ python3 -m pip install -r https://raw.githubusercontent.com/Hamza5/Pipeline-diacritizer/master/requirements.txt

Install the package

The easiest way to download and install Pipeline-diacritizer is by using pip because it is available as a Python wheel package (.whl).

(pipeline_diacritizer_env) $ python3 -m pip install pipeline-diacritizer

Running

After installing the package, you can run this tool from the same virtual environment.

(pipeline_diacritizer_env) $ pipeline_diacritizer --help