Installation

Installation via pip

Using uv (Recommended)

uv is a modern, fast Python package and project manager. It’s significantly faster than traditional tools.

1. Install uv (if not already installed):

   # On macOS and Linux
   curl -LsSf https://astral.sh/uv/install.sh | sh
   
   # On Windows
   powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
   

2. Create and activate a new environment (tested with Python >=3.10):

   uv venv --python 3.10 sarcasm
   source sarcasm/bin/activate  # On macOS/Linux
   # Or: sarcasm\Scripts\activate  # On Windows
   

3. Install SarcAsM and its dependencies via uv:

   uv pip install sarc-asm
   

   Note

   PyTorch will be installed automatically with CUDA support if available. For specific CUDA versions or CPU-only installation, see the PyTorch installation guide.

Using conda

Alternatively, you can use conda for environment management:

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

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

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

   pip install sarc-asm
   

   Note

   PyTorch will be installed automatically with CUDA support if available. For specific CUDA versions or CPU-only installation, see the PyTorch installation guide.

Installation via GitHub

Using uv (Recommended)

1. Clone repo from git:

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

2. Create a new environment (tested with Python >=3.10):

   uv venv --python 3.10
   source .venv/bin/activate  # On macOS/Linux
   # Or: .venv\Scripts\activate  # On Windows
   

3. Install all the required packages via:

   uv pip install .
   

   Note

   PyTorch will be installed automatically with CUDA support if available. For specific CUDA versions or CPU-only installation, see the PyTorch installation guide.

Using conda

1. Clone repo from git:

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

2. Create a new environment (tested with Python >=3.10):

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

3. Install all the required packages from pip via:

   pip install .
   

   Note

   PyTorch will be installed automatically with CUDA support if available. For specific CUDA versions or CPU-only installation, see the PyTorch installation guide.

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