File size: 10,813 Bytes
9c6594c |
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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
import hashlib
import json
import logging
import os
import pathlib
import shlex
import shutil
from typing import Any, Dict, List, Tuple
import wandb
import wandb.env
from wandb import docker
from wandb.apis.internal import Api
from wandb.sdk.launch.loader import (
builder_from_config,
environment_from_config,
registry_from_config,
)
from wandb.util import get_module
from .._project_spec import EntryPoint, LaunchProject
from ..errors import ExecutionError, LaunchError
from ..utils import LOG_PREFIX, event_loop_thread_exec
from .templates.dockerfile import (
ACCELERATOR_SETUP_TEMPLATE,
ENTRYPOINT_TEMPLATE,
PIP_TEMPLATE,
PYTHON_SETUP_TEMPLATE,
USER_CREATE_TEMPLATE,
)
_logger = logging.getLogger(__name__)
_WANDB_DOCKERFILE_NAME = "Dockerfile.wandb"
async def validate_docker_installation() -> None:
"""Verify if Docker is installed on host machine."""
find_exec = event_loop_thread_exec(shutil.which)
if not await find_exec("docker"):
raise ExecutionError(
"Could not find Docker executable. "
"Ensure Docker is installed as per the instructions "
"at https://docs.docker.com/install/overview/."
)
def join(split_command: List[str]) -> str:
"""Return a shell-escaped string from *split_command*.
Also remove quotes from double quoted strings. Ex:
"'local container queue'" --> "local container queue"
"""
return " ".join(shlex.quote(arg.replace("'", "")) for arg in split_command)
async def build_image_from_project(
launch_project: LaunchProject,
api: Api,
launch_config: Dict[str, Any],
) -> str:
"""Construct a docker image from a project and returns the URI of the image.
Arguments:
launch_project: The project to build an image from.
api: The API object to use for fetching the project.
launch_config: The launch config to use for building the image.
Returns:
The URI of the built image.
"""
assert launch_project.uri, "To build an image on queue a URI must be set."
launch_config = launch_config or {}
env_config = launch_config.get("environment", {})
if not isinstance(env_config, dict):
wrong_type = type(env_config).__name__
raise LaunchError(
f"Invalid environment config: {env_config} of type {wrong_type} "
"loaded from launch config. Expected dict."
)
environment = environment_from_config(env_config)
registry_config = launch_config.get("registry", {})
if not isinstance(registry_config, dict):
wrong_type = type(registry_config).__name__
raise LaunchError(
f"Invalid registry config: {registry_config} of type {wrong_type}"
" loaded from launch config. Expected dict."
)
registry = registry_from_config(registry_config, environment)
builder_config = launch_config.get("builder", {})
if not isinstance(builder_config, dict):
wrong_type = type(builder_config).__name__
raise LaunchError(
f"Invalid builder config: {builder_config} of type {wrong_type} "
"loaded from launch config. Expected dict."
)
builder = builder_from_config(builder_config, environment, registry)
if not builder:
raise LaunchError("Unable to build image. No builder found.")
launch_project.fetch_and_validate_project()
entry_point = (
launch_project.get_job_entry_point() or launch_project.override_entrypoint
)
assert entry_point is not None
wandb.termlog(f"{LOG_PREFIX}Building docker image from uri source")
image_uri = await builder.build_image(launch_project, entry_point)
if not image_uri:
raise LaunchError("Error building image uri")
else:
return image_uri
def image_tag_from_dockerfile_and_source(
launch_project: LaunchProject, dockerfile_contents: str
) -> str:
"""Hashes the source and dockerfile contents into a unique tag."""
image_source_string = launch_project.get_image_source_string()
unique_id_string = image_source_string + dockerfile_contents
image_tag = hashlib.sha256(unique_id_string.encode("utf-8")).hexdigest()[:8]
return image_tag
def get_docker_user(launch_project: LaunchProject, runner_type: str) -> Tuple[str, int]:
import getpass
username = getpass.getuser()
if runner_type == "sagemaker" and not launch_project.docker_image:
# unless user has provided their own image, sagemaker must run as root but keep the name for workdir etc
return username, 0
userid = launch_project.docker_user_id or os.geteuid()
return username, userid
def get_base_setup(
launch_project: LaunchProject, py_version: str, py_major: str
) -> str:
"""Fill in the Dockerfile templates for stage 2 of build.
CPU version is built on python, Accelerator version is built on user provided.
"""
minor = int(py_version.split(".")[1])
if minor < 12:
python_base_image = f"python:{py_version}-buster"
else:
python_base_image = f"python:{py_version}-bookworm"
if launch_project.accelerator_base_image:
_logger.info(
f"Using accelerator base image: {launch_project.accelerator_base_image}"
)
python_packages = [
f"python{py_version}",
f"libpython{py_version}",
"python3-pip",
"python3-setuptools",
]
base_setup = ACCELERATOR_SETUP_TEMPLATE.format(
accelerator_base_image=launch_project.accelerator_base_image,
python_packages=" \\\n".join(python_packages),
py_version=py_version,
)
else:
python_packages = [
"python3-dev",
"gcc",
] # gcc required for python < 3.7 for some reason
base_setup = PYTHON_SETUP_TEMPLATE.format(py_base_image=python_base_image)
return base_setup
# Move this into the build context manager.
def get_requirements_section(
launch_project: LaunchProject, build_context_dir: str, builder_type: str
) -> str:
if builder_type == "docker":
buildx_installed = docker.is_buildx_installed()
if not buildx_installed:
wandb.termwarn(
"Docker BuildX is not installed, for faster builds upgrade docker: https://github.com/docker/buildx#installing"
)
prefix = "RUN WANDB_DISABLE_CACHE=true"
elif builder_type == "kaniko":
prefix = "RUN WANDB_DISABLE_CACHE=true"
buildx_installed = False
if buildx_installed:
prefix = "RUN --mount=type=cache,mode=0777,target=/root/.cache/pip"
requirements_files = []
deps_install_line = None
base_path = pathlib.Path(build_context_dir)
# If there is a requirements.txt at root of build context, use that.
if (base_path / "src" / "requirements.txt").exists():
requirements_files += ["src/requirements.txt"]
deps_install_line = "pip install uv && uv pip install -r requirements.txt"
with open(base_path / "src" / "requirements.txt") as f:
requirements = f.readlines()
if not any(["wandb" in r for r in requirements]):
wandb.termwarn(f"{LOG_PREFIX}wandb is not present in requirements.txt.")
return PIP_TEMPLATE.format(
buildx_optional_prefix=prefix,
requirements_files=" ".join(requirements_files),
pip_install=deps_install_line,
)
# Elif there is pyproject.toml at build context, convert the dependencies
# section to a requirements.txt and use that.
elif (base_path / "src" / "pyproject.toml").exists():
tomli = get_module("tomli")
if tomli is None:
wandb.termwarn(
"pyproject.toml found but tomli could not be loaded. To "
"install dependencies from pyproject.toml please run "
"`pip install tomli` and try again."
)
else:
# First try to read deps from standard pyproject format.
with open(base_path / "src" / "pyproject.toml", "rb") as f:
contents = tomli.load(f)
project_deps = [
str(d) for d in contents.get("project", {}).get("dependencies", [])
]
if project_deps:
if not any(["wandb" in d for d in project_deps]):
wandb.termwarn(
f"{LOG_PREFIX}wandb is not present as a dependency in pyproject.toml."
)
with open(base_path / "src" / "requirements.txt", "w") as f:
f.write("\n".join(project_deps))
requirements_files += ["src/requirements.txt"]
deps_install_line = (
"pip install uv && uv pip install -r requirements.txt"
)
return PIP_TEMPLATE.format(
buildx_optional_prefix=prefix,
requirements_files=" ".join(requirements_files),
pip_install=deps_install_line,
)
# Else use frozen requirements from wandb run.
if (
not deps_install_line
and (base_path / "src" / "requirements.frozen.txt").exists()
):
requirements_files += [
"src/requirements.frozen.txt",
"_wandb_bootstrap.py",
]
deps_install_line = (
launch_project.parse_existing_requirements() + "python _wandb_bootstrap.py"
)
if not deps_install_line:
raise LaunchError(f"No dependency sources found for {launch_project}")
with open(base_path / "src" / "requirements.frozen.txt") as f:
requirements = f.readlines()
if not any(["wandb" in r for r in requirements]):
wandb.termwarn(
f"{LOG_PREFIX}wandb is not present in requirements.frozen.txt."
)
return PIP_TEMPLATE.format(
buildx_optional_prefix=prefix,
requirements_files=" ".join(requirements_files),
pip_install=deps_install_line,
)
else:
# this means no deps file was found
requirements_line = "RUN mkdir -p env/" # Docker fails otherwise
wandb.termwarn("No requirements file found. No packages will be installed.")
return requirements_line
def get_user_setup(username: str, userid: int, runner_type: str) -> str:
if runner_type == "sagemaker":
# sagemaker must run as root
return "USER root"
user_create = USER_CREATE_TEMPLATE.format(uid=userid, user=username)
user_create += f"\nUSER {username}"
return user_create
def get_entrypoint_setup(
entry_point: EntryPoint,
) -> str:
return ENTRYPOINT_TEMPLATE.format(entrypoint=json.dumps(entry_point.command))
|