You will need Python 3.6 and above (64-bit) as well as the Rust compiler installed.
pip install camel-tools
# or run the following if you already have camel_tools installed
pip install camel-tools --upgrade
# Clone the repo
git clone https://github.com/CAMeL-Lab/camel_tools.git
cd camel_tools
# Install from source
pip install .
# or run the following if you already have camel_tools installed
pip install --upgrade .
To install the data sets required by CAMeL Tools components run one of the following:
# To install all data sets
camel_data full
# or for a light weight package for morphology and MLE disambiguation only
camel_data light
See :ref:`available_packages` for a comparison.
By default, data is stored in ~/.camel_tools
.
Alternatively, if you would like to install the data in a different location,
you need to set the CAMELTOOLS_DATA
environment variable to the desired
path.
Add the following to your .bashrc
, .zshrc
, .profile
,
etc:
export CAMELTOOLS_DATA=/path/to/camel_tools_data
Note: CAMeL Tools has been tested on Windows 10. The Dialect Identification component is not available on Windows at this time.
pip install camel-tools -f https://download.pytorch.org/whl/torch_stable.html
# or run the following if you already have camel_tools installed
pip install --upgrade -f https://download.pytorch.org/whl/torch_stable.html camel-tools
# Clone the repo
git clone https://github.com/CAMeL-Lab/camel_tools.git
cd camel_tools
# Install from source
pip install -f https://download.pytorch.org/whl/torch_stable.html .
pip install --upgrade -f https://download.pytorch.org/whl/torch_stable.html .
To install the data packages required by CAMeL Tools components, run one of the following commands:
# To install all data sets
camel_data full
# or for a light weight package for morphology and MLE disambiguation only
camel_data light
See :ref:`available_packages` for a comparison.
By default, data is stored in
C:\Users\your_user_name\AppData\Roaming\camel_tools
.
Alternatively, if you would like to install the data in a different location,
you need to set the CAMELTOOLS_DATA
environment variable to the desired
path. Below are the instructions to do so (on Windows 10):
- Press the Windows button and type
env
. - Click on Edit the system environment variables (Control panel).
- Click on the Environment Variables... button.
- Click on the New... button under the User variables panel.
- Type
CAMELTOOLS_DATA
in the Variable name input box and the desired data path in Variable value. Alternatively, you can browse for the data directory by clicking on the Browse Directory... button. - Click OK on all the opened windows.
To get started, you can follow along the Guided Tour for a quick overview of the components provided by CAMeL Tools.
See :doc:`cli_tools` for information on using the command-line tools or :doc:`api` for information on using the Python API.