Makefile

#  Copyright 2024 The HuggingFace Team. All rights reserved.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
SHELL := /bin/bash
CURRENT_DIR = $(shell pwd)
DEFAULT_CLONE_URL := https://github.com/huggingface/optimum-tpu.git
# If CLONE_URL is empty, revert to DEFAULT_CLONE_URL
REAL_CLONE_URL = $(if $(CLONE_URL),$(CLONE_URL),$(DEFAULT_CLONE_URL))

.PHONY:	build_dist style style_check clean

TGI_VERSION ?= v2.4.1

rwildcard=$(wildcard $1) $(foreach d,$1,$(call rwildcard,$(addsuffix /$(notdir $d),$(wildcard $(dir $d)*))))

VERSION := $(shell awk '/__version__ = "(.*)"/{print $$3}' optimum/tpu/version.py | sed 's/"//g')

PACKAGE_DIST = dist/optimum-tpu-$(VERSION).tar.gz
PACKAGE_WHEEL = dist/optimum_tpu-$(VERSION)-py3-none-any.whl
PACKAGE_PYTHON_FILES = $(call rwildcard, optimum/*.py)
PACKAGE_FILES = $(PACKAGE_PYTHON_FILES)  \
				setup.cfg \
				pyproject.toml \
				README.md \
				MANIFEST.in

# Package build recipe
$(PACKAGE_DIST) $(PACKAGE_WHEEL): $(PACKAGE_FILES)
	python -m build

clean:
	rm -rf dist deps
	make -C text-generation-inference/server/ clean

tpu-tgi:
	docker build --rm -f text-generation-inference/docker/Dockerfile \
	             --build-arg VERSION=$(VERSION) \
	             --build-arg TGI_VERSION=$(TGI_VERSION) \
	             --ulimit nofile=100000:100000 \
	             -t huggingface/optimum-tpu:$(VERSION)-tgi .
	docker tag huggingface/optimum-tpu:$(VERSION)-tgi huggingface/optimum-tpu:latest

tpu-tgi-ie:
	docker build --rm -f text-generation-inference/docker/Dockerfile \
				 --target inference-endpoint \
	             --build-arg VERSION=$(VERSION) \
	             --build-arg TGI_VERSION=$(TGI_VERSION) \
				 --ulimit nofile=100000:100000 \
				 -t huggingface/optimum-tpu:$(VERSION)-tgi .
	docker tag huggingface/optimum-tpu:$(VERSION)-tgi huggingface/optimum-tpu:latest-ie

tpu-tgi-gcp:
	docker build --rm -f text-generation-inference/docker/Dockerfile \
				 --target google-cloud-containers \
				 --build-arg ENABLE_GCP_INTEGRATION=1 \
				 --ulimit nofile=100000:100000 \
				 -t huggingface/optimum-tpu:$(VERSION)-tgi-gcp .
	docker tag huggingface/optimum-tpu:$(VERSION)-tgi-gcp huggingface/optimum-tpu:latest-gcp

# Run code quality checks
style_check:
	ruff check .

style:
	ruff check . --fix

# Utilities to release to PyPi
build_dist_install_tools:
	python -m pip install build
	python -m pip install twine

build_dist: ${PACKAGE_DIST} ${PACKAGE_WHEEL}

pypi_upload: ${PACKAGE_DIST} ${PACKAGE_WHEEL}
	python -m twine upload ${PACKAGE_DIST} ${PACKAGE_WHEEL}

# Tests
test_installs:
	python -m pip install -r requirements.txt
	python -m pip install .[tests] -f https://storage.googleapis.com/libtpu-releases/index.html

tests: test_installs
	python -m pytest -sv tests

# Stand-alone TGI server for unit tests outside of TGI container
tgi_server:
	python -m pip install -r text-generation-inference/server/build-requirements.txt
	make -C text-generation-inference/server clean
	VERSION=${VERSION} TGI_VERSION=${TGI_VERSION} make -C text-generation-inference/server gen-server

jetstream_requirements: test_installs
	python optimum/tpu/cli.py install-jetstream-pytorch --yes

tgi_test_jetstream: test_installs jetstream_requirements tgi_server
	find text-generation-inference -name "text_generation_server-$(VERSION)-py3-none-any.whl" \
	                               -exec python -m pip install --force-reinstall {} \;
	python -m pytest -sv text-generation-inference/tests -m jetstream

tgi_test: test_installs tgi_server
	find text-generation-inference -name "text_generation_server-$(VERSION)-py3-none-any.whl" \
	                               -exec python -m pip install --force-reinstall {} \;
	python -m pytest -sv text-generation-inference/tests -m torch_xla

tgi_docker_test: tpu-tgi
	python -m pip install -r text-generation-inference/integration-tests/requirements.txt
	python -m pytest -sv text-generation-inference/integration-tests