Skip to content

Installation

Distribution

Stained Glass Core is distributed as an whl package file, with a naming scheme similar to stainedglass_core-1.2.3-py310-none-any.whl, where 1.2.3 is the package version number and py310 is the Python version it is built for.

Each wheel file is built for a specific version of Python, but is compatible with major platforms including Linux (x86_64 and aarch64/arm64), Mac OS (Intel and Apple Silicon), and Windows (x86_64 only).

PyTorch Dependency

Stained Glass Core depends on having torch installed, but by default will not install it automatically. You can install torch separately by following the instructions on the PyTorch website. Make sure to install the version appropriate to your operating system, Python version, and compute platform (CPU-only, CUDA, etc.).

Stained Glass Core is tested on both PyTorch 2.1 and the most recently released version of PyTorch.

Install with pip

Stained Glass Core can be installed using pip:

python -m pip install stainedglass_core-1.2.3-py310-none-any.whl

Replace the path with the actual path to the wheel file.

Install with pip (including HuggingFace optional dependencies)

If you plan on using the optional HuggingFace integration, you can install Stained Glass Core with the huggingface extra:

python -m pip install "stainedglass_core-1.2.3-py310-none-any.whl[huggingface]"

Replace the path with the actual path to the wheel file. Depending on your operating system, you may or may not need the quotes around the wheel file path and extra designator.

Info

The HuggingFace integration is required for Large Language Models.