Installation

Installation via pip

1. Create and activate a new environment (tested with Python 3.10 and 3.11):

   conda create -n sarcasm python==3.10
   conda activate sarcasm
   

2. Install PyTorch. For CPU and Apple Silicon (M1, M2, …), install the plain version. For CUDA-capable systems with NVIDIA GPU, install CUDA toolkit. Ensure that the CUDA toolkit version matches the PyTorch version requirements.

3. Install SarcAsM and its dependencies via pip from PyPI:

   pip install sarc-asm
   

Installation via github

1. Clone repo from git:

   git clone https://github.com/danihae/SarcAsM
   cd sarcasm
   

2. Create a new environment (tested with Python 3.10 and 3.11):

   conda create -n sarcasm python==3.10
   conda activate sarcasm
   

3. Install PyTorch. For CUDA-capable systems, install CUDA toolkit. Ensure that the CUDA toolkit version matches the PyTorch version requirements.

4. Finally, install all the required packages from pip via:

   pip install -r requirements.txt
   

The full installation usually takes less than 5 min, depending on internet connection.