feat(ray): unify cli commands (#167)

Because

- Current DX of custom model development is not user friendly

This commit

- have a unified entry command `instill` for all operation
- remove the repo field in instill.yaml, which currently used for
{namespace}/{model-id}
- have `name` as positional field for each command, format is
{namespace}/{model-id}

Author: heiruwu

instill/helpers/build.py

@@ -0,0 +1,230 @@
+import argparse
+
+# import hashlib
+import os
+import platform
+import shutil
+import subprocess
+import tempfile
+
+import ray
+import yaml
+
+import instill
+from instill.helpers.const import DEFAULT_DEPENDENCIES
+from instill.helpers.errors import ModelConfigException
+from instill.utils.logger import Logger
+
+
+def config_check_required_fields(c):
+    if "build" not in c or c["build"] is None:
+        raise ModelConfigException("build")
+    if "gpu" not in c["build"] or c["build"]["gpu"] is None:
+        raise ModelConfigException("gpu")
+    if "python_version" not in c["build"] or c["build"]["python_version"] is None:
+        raise ModelConfigException("python_version")
+
+
+def cli():
+    if platform.machine() in ("i386", "AMD64", "x86_64"):
+        default_platform = "amd64"
+    else:
+        default_platform = platform.machine()
+    parser = argparse.ArgumentParser()
+    subcommands = parser.add_subparsers(required=True)
+
+    # init
+    init_parser = subcommands.add_parser("init", help="Initialize model directory")
+    init_parser.set_defaults(func=init)
+
+    # build
+    build_parser = subcommands.add_parser("build", help="Build model image")
+    build_parser.set_defaults(func=build)
+    build_parser.add_argument(
+        "name",
+        help="user and model namespace, in the format of <user-id>/<model-id>",
+    )
+    build_parser.add_argument(
+        "-t",
+        "--tag",
+        help="tag for the model image, default to `latest`",
+        # default=hashlib.sha256().hexdigest(),
+        default="latest",
+        required=False,
+    )
+    build_parser.add_argument(
+        "--no-cache",
+        help="build the image without cache",
+        action="store_true",
+        required=False,
+    )
+    build_parser.add_argument(
+        "--target-arch",
+        help="target platform architecture for the model image, default to host",
+        default=default_platform,
+        choices=["arm64", "amd64"],
+        required=False,
+    )
+
+    # push
+    push_parser = subcommands.add_parser("push", help="Push model image")
+    push_parser.set_defaults(func=push)
+    push_parser.add_argument(
+        "name",
+        help="user and model namespace, in the format of <user-id>/<model-id>",
+    )
+    push_parser.add_argument(
+        "-u",
+        "--url",
+        help="image registry url, in the format of host:port, default to api.instill.tech",
+        default="api.instill.tech",
+        required=False,
+    )
+    push_parser.add_argument(
+        "-t",
+        "--tag",
+        help="tag for the model image, default to `latest`",
+        default="latest",
+        required=False,
+    )
+
+    args = parser.parse_args()
+    args.func(args)
+
+
+def init(_):
+    shutil.copyfile(
+        __file__.replace("cli.py", "init-templates/instill.yaml"),
+        f"{os.getcwd()}/instill.yaml",
+    )
+    shutil.copyfile(
+        __file__.replace("cli.py", "init-templates/model.py"),
+        f"{os.getcwd()}/model.py",
+    )
+    shutil.copyfile(
+        __file__.replace("cli.py", "init-templates/.dockerignore"),
+        f"{os.getcwd()}/.dockerignore",
+    )
+
+
+def build(args):
+    try:
+        Logger.i("[Instill Builder] Loading config file...")
+        with open("instill.yaml", "r", encoding="utf8") as f:
+            Logger.i("[Instill Builder] Parsing config file...")
+            config = yaml.safe_load(f)
+
+        config_check_required_fields(config)
+
+        build_params = config["build"]
+
+        python_version = build_params["python_version"].replace(".", "")
+        ray_version = ray.__version__
+        instill_version = instill.__version__
+
+        if not build_params["gpu"]:
+            cuda_suffix = ""
+        elif (
+            "cuda_version" in build_params and not build_params["cuda_version"] is None
+        ):
+            cuda_suffix = f'-cu{build_params["cuda_version"].replace(".", "")}'
+        else:
+            cuda_suffix = "-gpu"
+
+        system_str = ""
+        if (
+            "system_packages" in build_params
+            and not build_params["system_packages"] is None
+        ):
+            for p in build_params["system_packages"]:
+                system_str += p + " "
+
+        packages_str = ""
+        if (
+            "python_packages" in build_params
+            and not build_params["python_packages"] is None
+        ):
+            for p in build_params["python_packages"]:
+                packages_str += p + " "
+        for p in DEFAULT_DEPENDENCIES:
+            packages_str += p + " "
+        packages_str += f"instill-sdk=={instill_version}"
+
+        with tempfile.TemporaryDirectory() as tmpdir:
+            shutil.copyfile(
+                __file__.replace("cli.py", "init-templates/Dockerfile"),
+                f"{tmpdir}/Dockerfile",
+            )
+            shutil.copytree(os.getcwd(), tmpdir, dirs_exist_ok=True)
+
+            target_arch_suffix = "-aarch64" if args.target_arch == "arm64" else ""
+
+            Logger.i("[Instill Builder] Building model image...")
+            command = [
+                "docker",
+                "buildx",
+                "build",
+                "--build-arg",
+                f"TARGET_ARCH_SUFFIX={target_arch_suffix}",
+                "--build-arg",
+                f"RAY_VERSION={ray_version}",
+                "--build-arg",
+                f"PYTHON_VERSION={python_version}",
+                "--build-arg",
+                f"CUDA_SUFFIX={cuda_suffix}",
+                "--build-arg",
+                f"PACKAGES={packages_str}",
+                "--build-arg",
+                f"SYSTEM_PACKAGES={system_str}",
+                "--platform",
+                f"linux/{args.target_arch}",
+                "-t",
+                f"{args.name}:{args.tag}",
+                tmpdir,
+                "--load",
+            ]
+            if args.no_cache:
+                command.append("--no-cache")
+            subprocess.run(
+                command,
+                check=True,
+            )
+            Logger.i(f"[Instill Builder] {args.name}:{args.tag} built")
+    except subprocess.CalledProcessError:
+        Logger.e("[Instill Builder] Build failed")
+    except Exception as e:
+        Logger.e("[Instill Builder] Prepare failed")
+        Logger.e(e)
+    finally:
+        Logger.i("[Instill Builder] Done")
+
+
+def push(args):
+    try:
+        registry = args.url
+
+        subprocess.run(
+            [
+                "docker",
+                "tag",
+                f"{args.name}:{args.tag}",
+                f"{registry}/{args.name}:{args.tag}",
+            ],
+            check=True,
+        )
+        Logger.i("[Instill Builder] Pushing model image...")
+        subprocess.run(
+            ["docker", "push", f"{registry}/{args.name}:{args.tag}"], check=True
+        )
+        Logger.i(f"[Instill Builder] {registry}/{args.name}:{args.tag} pushed")
+    except subprocess.CalledProcessError:
+        Logger.e("[Instill Builder] Push failed")
+    except Exception as e:
+        Logger.e("[Instill Builder] Prepare failed")
+        Logger.e(e)
+    finally:
+        Logger.i("[Instill Builder] Done")
+
+
+if __name__ == "__main__":
+    cli()

instill/helpers/cli.py

@@ -0,0 +1,20 @@
+build:
+  # set to true if your model requires GPU
+  gpu: true
+
+  # python version, currently only support 3.11
+  python_version: "3.11"
+
+  # cuda version if `gpu` is set to true
+  # support 11.5, 11.6 ,11.7 ,11.7 ,12.1
+  cuda_version: "12.1"
+
+  # a list of python packages in the format of {package-name}=={version}
+  # python_packages:
+  #   - torch==2.3.1
+  #   - transformers==4.41.2
+
+  # a list of system packages from apt package manager
+  # system_packages:
+  #   - htop
+  #   - libglib2.0-0