Environment:Intel Ipex llm Build Environment
| Knowledge Sources | |
|---|---|
| Domains | Infrastructure, Packaging |
| Last Updated | 2026-02-09 04:00 GMT |
Overview
Development environment for building and packaging the ipex-llm Python package, providing setuptools, wheel, and platform-specific build tools for source and binary distribution.
Description
This environment provides the build and packaging context for the ipex-llm Python package itself. It includes setuptools for package configuration, wheel for binary distribution creation, and platform-specific build tools for compiling native extensions. This environment is used by developers and CI/CD pipelines to build the ipex-llm package from source, create distributable wheel files, and manage package versioning and metadata through `setup.py` or `pyproject.toml` configurations.
Usage
Use this environment for Building the ipex-llm Package from source, creating wheel distributions, and running the package setup workflow. It is the mandatory prerequisite for running the IPEX-LLM package build and installation from source code.
System Requirements
| Category | Requirement | Notes |
|---|---|---|
| OS | Ubuntu 22.04 LTS, Windows 10/11, or macOS | Cross-platform build support |
| Hardware | x86_64 CPU | No GPU required for package building |
| Python | Python 3.9+ | Python 3.11 recommended for building |
| Build Tools | Platform C compiler | `gcc`/`g++` on Linux, MSVC on Windows, Xcode CLT on macOS |
Dependencies
System Packages
- C/C++ compiler (`gcc`/`g++` on Linux, MSVC on Windows)
- `make` or `ninja` (Linux/macOS)
Python Packages
- `setuptools` >= 63.0
- `wheel`
- `build`
- `pip` >= 21.0
- `twine` (optional, for uploading to PyPI)
Credentials
The following may be required depending on the build and release workflow:
- PyPI Token: Required only if uploading packages to PyPI via `twine upload`.
- GitHub Token: Required only if the build process fetches private dependencies from GitHub.
Quick Install
# Install build tools
pip install --upgrade setuptools wheel build pip
# Clone the repository
git clone https://github.com/intel/ipex-llm.git
cd ipex-llm
# Build the package
python -m build
# Install from the built wheel
pip install dist/ipex_llm-*.whl
# (Optional) Upload to PyPI
pip install twine
twine upload dist/*
Common Errors
| Error Message | Cause | Solution |
|---|---|---|
| `ModuleNotFoundError: No module named 'setuptools'` | Setuptools not installed | `pip install setuptools` |
| `error: command 'gcc' failed` | C compiler not installed | Install `gcc` and `g++` on Linux; install MSVC Build Tools on Windows |
| `wheel build failed` | Missing native build dependencies | Ensure all system-level build tools and development headers are installed |
| `version conflict` | Conflicting package versions in build environment | Use a clean virtual environment for building |
Compatibility Notes
- Cross-Platform: The build environment supports Linux, Windows, and macOS. Platform-specific native extensions may require platform-specific build tools.
- Virtual Environment: Building in a clean virtual environment is recommended to avoid dependency conflicts.
- No GPU Required: Package building does not require GPU hardware. GPU support is a runtime dependency only.