Installation

Installation#

There are different ways to install ggml-ot, depending on your needs. It is recommended to install ggml-ot inside a virtual environment to avoid dependency conflicts. You can create one using venv, conda or poetry

Pip/PyPI#

The easiest way to get started is to install the latest release from PyPI:

   pip install ggml-ot

Development Version#

If you want to use the latest version directly from GitHub, you can clone the repository and install with Poetry:

   git clone https://github.com/DaminK/ggml-ot
   cd ggml-ot
   pip install poetry
   poetry lock && poetry install

This will install the package in a regular environment without developer tools.

For contributing to ggml-ot, you can install it in different modes, see the contributor guide for more details.

GPU Support#

ggml-ot uses PyTorch under the hood. By default, pip install ggml-ot installs the CPU-only build of PyTorch. To use ggml_ot.settings.device = "cuda", you need a CUDA-enabled PyTorch installation. Install it before installing ggml-ot:

   pip install torch --index-url https://download.pytorch.org/whl/cu121   # CUDA 12.1
   pip install ggml-ot

See the PyTorch install guide for other CUDA versions.