instruct-lab-nvidia-container/Makefile at main · fontivan/instruct-lab-nvidia-container · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# Makefile derived from https://web.archive.org/web/20240205205603/https://venthur.de/2021-03-31-python-makefiles.html

# Get the directory this Makefile is sitting in
ROOT_DIR := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))

# system python interpreter. used only to create virtual environment
PY = python3
VENV = venv
BIN=$(ROOT_DIR)/$(VENV)/bin

SHELL_FILES := $(shell find $(ROOT_DIR)  -type f -name "*.sh" | grep -v $(VENV))

# These can be overwritten by shell environment
CONTAINER_BACKEND ?= podman
CONTAINER_BASE_IMAGE ?= docker.io/rockylinux/rockylinux:9-minimal
CONTAINER_DIR ?= /work
CONTAINER_NAME ?= instruct-lab-nvidia-container
CUDA_MAJOR_VERSION ?= 12
CUDA_MINOR_VERSION ?= 4
HUGGINGFACE_CACHE_DIR ?= ${HOME}/.cache/huggingface
LAB_LISTEN_IF ?= 0.0.0.0
NVIDIA_DEVICE ?= nvidia.com/gpu=all

# If you want to change the port you need to change it in config.yaml too
LAB_LISTEN_PORT := 8000

# By default we we just performs lints since building the image is resource intense
all: bashate shellcheck hadolint yamllint

# Container target
# Clean any existing container, build a new image, and deploy a new container
container: clean-container build-image deploy-container

# venv is used for ci linting purposes
$(VENV): requirements/ci.txt
	$(PY) -m venv $(VENV)
	$(BIN)/pip install --upgrade -r requirements/ci.txt
	touch $(VENV)

# Run bashate on all *.sh files in repo
.PHONY: bashate
bashate: $(VENV)
	$(BIN)/bashate $(SHELL_FILES)

# Run shellcheck on all *.sh files in repo
.PHONY: shellcheck
shellcheck: $(VENV)
	$(BIN)/shellcheck -x $(SHELL_FILES)

# Run hadolint on the Containerfile
.PHONY: hadolint
hadolint: $(VENV)
	$(BIN)/hadolint $(ROOT_DIR)/Containerfile

# Run yamllint on all *.yml/*.yaml files in repo
.PHONY: yamllint
yamllint: $(VENV)
	$(BIN)/yamllint .

# Build the image using podman
.PHONY: build-image
build-image:
	${CONTAINER_BACKEND} build \
	--tag $(CONTAINER_NAME) \
	--build-arg CONTAINER_BASE_IMAGE="$(CONTAINER_BASE_IMAGE)" \
	--build-arg CONTAINER_DIR="$(CONTAINER_DIR)" \
	--build-arg CUDA_MAJOR_VERSION="$(CUDA_MAJOR_VERSION)" \
	--build-arg CUDA_MINOR_VERSION="$(CUDA_MINOR_VERSION)" \
	.

# Deploy the latest built image using podman
.PHONY: deploy-container
deploy-container:
	@echo "Checking if INSTRUCT_LAB_TAXONOMY_PATH is defined in environment"
	test -n "${INSTRUCT_LAB_TAXONOMY_PATH}"
	${CONTAINER_BACKEND} run \
		-it \
		-d \
		--name $(CONTAINER_NAME) \
		--user root \
		-p "${LAB_LISTEN_IF}:${LAB_LISTEN_PORT}:${LAB_LISTEN_PORT}" \
		--volume "${INSTRUCT_LAB_TAXONOMY_PATH}:$(CONTAINER_DIR)/taxonomy:rw,Z" \
		--volume "${HUGGINGFACE_CACHE_DIR}:/root/.cache/huggingface:rw,Z" \
		--device $(NVIDIA_DEVICE) \
		--security-opt=label=disable \
		localhost/$(CONTAINER_NAME):latest \
		$(CONTAINER_DIR)/entrypoint.sh

# Remove any existing container, if one exists
.PHONY: clean-container
clean-container:
	${CONTAINER_BACKEND} container rm -f $(CONTAINER_NAME)

# Open an interactive shell into the container
.PHONY: exec-container
exec-container:
	${CONTAINER_BACKEND} exec -it --user root $(CONTAINER_NAME) $(CONTAINER_DIR)/entrypoint.sh

# Clean venv and related files
clean:
	rm -rf $(VENV)
	find . -type f -name *.pyc -delete
	find . -type d -name __pycache__ -delete