litert-cli 0.1.0__py3-none-any.whl

examples/utils.ps1

@@ -0,0 +1,163 @@
+# Copyright 2026 The LiteRT CLI Authors.
+#
+# 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.
+# ==============================================================================
+
+# Shared utilities and helpers for LiteRT CLI demo scripts on Windows
+
+$esc = [char]27
+$GREEN = "$esc[0;32m"
+$BLUE = "$esc[0;34m"
+$YELLOW = "$esc[0;33m"
+$RED = "$esc[0;31m"
+$NC = "$esc[0m"
+$BOLD = "$esc[1m"
+
+$script:TOTAL_CASES = 0
+$script:TOTAL_PASSED = 0
+$script:TOTAL_FAILED = 0
+$script:PASSED_CASES = @()
+$script:FAILED_CASES = @()
+
+# Helper for dynamic Android check (supports both authorized and unauthorized devices)
+function Has-AndroidDevice {
+    try {
+        $devices = adb devices 2>$null
+        if ($null -ne $devices) {
+            foreach ($line in $devices) {
+                if ($line -match "\s+(device|unauthorized)$") {
+                    return $true
+                }
+            }
+        }
+    } catch {}
+    return $false
+}
+
+# Helper to verify if LiteRT GPU accelerator is supported on Desktop (excluding software emulation like llvmpipe)
+function Has-DesktopGpu {
+    param([string]$modelFile)
+    
+    # Double escape backslashes for Python string literal
+    $pythonModelPath = $modelFile.Replace('\', '\\')
+    
+    $pythonCmd = @"
+import sys
+try:
+    from ai_edge_litert.compiled_model import CompiledModel
+    from ai_edge_litert.hardware_accelerator import HardwareAccelerator
+    cm = CompiledModel.from_file('$pythonModelPath', HardwareAccelerator.GPU)
+except Exception as e:
+    sys.exit(1)
+"@
+    
+    try {
+        $output = & python -c $pythonCmd 2>&1
+        $status = $LASTEXITCODE
+        if ($status -eq 0 -and $output -notmatch "llvmpipe" -and $output -notmatch "lavapipe") {
+            return $true
+        }
+    } catch {}
+    return $false
+}
+
+# Robust runner for a test command with isolation and formatting
+function Run-Case {
+    param(
+        [string]$title,
+        [scriptblock]$cmdBlock
+    )
+
+    $esc = [char]27
+    $BLUE = "$esc[0;34m"
+    $GREEN = "$esc[0;32m"
+    $RED = "$esc[0;31m"
+    $NC = "$esc[0m"
+    $BOLD = "$esc[1m"
+
+    Write-Host ""
+    Write-Host "${BLUE}▶ Running:${NC} ${BOLD}$title${NC}"
+    $cmdStr = $cmdBlock.ToString().Trim()
+    Write-Host "$esc[90mCommand: $cmdStr$NC"
+    Write-Host "$esc[90m------------------------------------------------------------$NC"
+
+    $oldErrorActionPreference = $ErrorActionPreference
+    $ErrorActionPreference = "Continue"
+
+    & $cmdBlock
+    $status = $LASTEXITCODE
+
+    if ($null -eq $status) {
+        if ($?) { $status = 0 } else { $status = 1 }
+    }
+
+    $ErrorActionPreference = $oldErrorActionPreference
+    
+    Write-Host "$esc[90m------------------------------------------------------------$NC"
+    if ($status -eq 0) {
+        Write-Host "${GREEN}✔ SUCCESS:${NC} ${GREEN}${BOLD}$title${NC}"
+        $script:TOTAL_PASSED++
+        $script:PASSED_CASES += $title
+    } else {
+        Write-Host "${RED}✘ FAILED (Exit Code: $status):${NC} ${RED}${BOLD}$title${NC}"
+        $script:TOTAL_FAILED++
+        $script:FAILED_CASES += $title
+    }
+    $script:TOTAL_CASES++
+    return $status
+}
+
+# Prints the final summary report for the demo
+function Print-SummaryReport {
+    param([string]$modelName)
+
+    $esc = [char]27
+    $BLUE = "$esc[0;34m"
+    $GREEN = "$esc[0;32m"
+    $RED = "$esc[0;31m"
+    $NC = "$esc[0m"
+    $BOLD = "$esc[1m"
+
+    $upperModel = $modelName.ToUpper()
+
+    Write-Host ""
+    Write-Host "${BLUE}${BOLD}==================================================================${NC}"
+    Write-Host "${BLUE}${BOLD}>>> ${upperModel} TEST SUMMARY${NC}"
+    Write-Host "${BLUE}${BOLD}==================================================================${NC}"
+    Write-Host "Total Cases Run: ${BOLD}$script:TOTAL_CASES${NC}"
+    Write-Host "Passed:          ${GREEN}${BOLD}$script:TOTAL_PASSED${NC}"
+    Write-Host "Failed:          ${RED}${BOLD}$script:TOTAL_FAILED${NC}"
+
+    if ($script:TOTAL_PASSED -gt 0) {
+        Write-Host ""
+        Write-Host "${GREEN}${BOLD}Passed Cases:${NC}"
+        foreach ($case in $script:PASSED_CASES) {
+            Write-Host "  - ${GREEN}$case${NC}"
+        }
+    }
+
+    if ($script:TOTAL_FAILED -gt 0) {
+        Write-Host ""
+        Write-Host "${RED}${BOLD}Failed Cases:${NC}"
+        foreach ($case in $script:FAILED_CASES) {
+            Write-Host "  - ${RED}$case${NC}"
+        }
+        Write-Host "${BLUE}${BOLD}==================================================================${NC}"
+        Exit 1
+    }
+
+    Write-Host ""
+    Write-Host "${GREEN}${BOLD}All ${modelName} CLI commands executed successfully!${NC}"
+    Write-Host "${BLUE}${BOLD}==================================================================${NC}"
+    Exit 0
+}

examples/utils.sh

@@ -0,0 +1,184 @@
+#!/bin/bash
+# Copyright 2026 The LiteRT CLI Authors.
+#
+# 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.
+# ==============================================================================
+
+# Shared utilities and helpers for LiteRT CLI demo scripts
+
+# Color codes for beautiful output
+GREEN='\033[0;32m'
+BLUE='\033[0;34m'
+YELLOW='\033[0;33m'
+RED='\033[0;31m'
+NC='\033[0m' # No Color
+BOLD='\033[1m'
+
+# Run case tracking variables
+TOTAL_CASES=0
+TOTAL_PASSED=0
+TOTAL_FAILED=0
+PASSED_CASES=()
+FAILED_CASES=()
+
+# Helper for dynamic Android check (supports both authorized and unauthorized devices)
+function has_android_device() {
+  adb devices 2>/dev/null | grep -E -q "\s+(device|unauthorized)$"
+}
+
+# Helper to verify if LiteRT GPU accelerator is supported on Desktop (excluding software emulation like llvmpipe)
+function has_desktop_gpu() {
+  local model_file="$1"
+  local output
+  output=$(python3 -c "
+import sys
+try:
+  from ai_edge_litert.compiled_model import CompiledModel
+  from ai_edge_litert.hardware_accelerator import HardwareAccelerator
+  cm = CompiledModel.from_file('$model_file', HardwareAccelerator.GPU)
+except Exception:
+  sys.exit(1)
+" 2>&1)
+  local status=$?
+
+  if [ $status -eq 0 ] && [[ ! "$output" =~ "llvmpipe" && ! "$output" =~ "lavapipe" ]]; then
+    return 0
+  else
+    return 1
+  fi
+}
+
+
+
+# Auto-detect REPO_ROOT from utils.sh location
+export UTILS_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+export REPO_ROOT="$(cd "$UTILS_DIR/.." && pwd)"
+
+# Shared environment initialization for demo scripts
+function setup_test_env() {
+  local test_name="$1"
+  local title="$2"
+  local extra_deps="${3:-}"
+
+  echo -e "${BLUE}${BOLD}==================================================================${NC}"
+  echo -e "${BLUE}${BOLD}>>> LiteRT CLI $title${NC}"
+  echo -e "${BLUE}${BOLD}==================================================================${NC}"
+
+  if [ "${LITERT_CLI_SHARED_VENV:-false}" == "true" ]; then
+    export LITERT_CLI_ROOT="/tmp/litert_cli_shared"
+    local test_root="$LITERT_CLI_ROOT"
+    mkdir -p "$test_root"
+    cd "$test_root"
+
+    if [ ! -d ".venv" ] || [ ! -f ".venv/bin/litert" ]; then
+      echo -e "\n${YELLOW}Creating Shared Python virtual environment with UV...${NC}"
+      UV_INDEX_URL=https://pypi.org/simple uv venv --clear --python=3.13 --seed
+      source .venv/bin/activate
+      echo -e "${YELLOW}Installing litert-cli with all extras into shared venv...${NC}"
+      uv pip install -e "$REPO_ROOT[convert,quantize,lm,compile]"
+    else
+      echo -e "\n${GREEN}Reusing existing shared virtual environment at $test_root...${NC}"
+      source .venv/bin/activate
+    fi
+  else
+    export LITERT_CLI_ROOT="/tmp/litert_cli_$test_name"
+    local test_root="$LITERT_CLI_ROOT"
+
+    echo -e "\n${YELLOW}Setting up isolated workspace at: $test_root...${NC}"
+    rm -rf "$test_root"
+    mkdir -p "$test_root"
+    cd "$test_root"
+
+    echo -e "${YELLOW}Creating Isolated Python virtual environment with UV...${NC}"
+    UV_INDEX_URL=https://pypi.org/simple uv venv --clear --python=3.13 --seed
+    source .venv/bin/activate
+
+    if [ -n "$extra_deps" ]; then
+      echo -e "${YELLOW}Installing litert-cli with [$extra_deps] extra...${NC}"
+      uv pip install -e "$REPO_ROOT[$extra_deps]"
+    else
+      echo -e "${YELLOW}Installing litert-cli...${NC}"
+      uv pip install -e "$REPO_ROOT"
+    fi
+  fi
+
+  export MODEL_DIR="$test_root/models"
+  export MODELS_CACHE="$test_root/models"
+  mkdir -p "$MODEL_DIR"
+
+  export TEST_DATA_DIR="$REPO_ROOT/litert_cli/test_data"
+  # Symlink test data directly into workspace for clean command syntax
+  ln -sf "$TEST_DATA_DIR/"* .
+}
+
+
+# Robust runner for a test command with isolation and formatting
+function run_case() {
+    local title="$1"
+    shift
+    
+    echo -e "\n${BLUE}▶ Running:${NC} ${BOLD}$title${NC}"
+    echo -e "\033[90mCommand: $*\033[0m"
+    echo -e "\033[90m------------------------------------------------------------\033[0m"
+    
+    set +e
+    "$@"
+    local status=$?
+    set -e
+    
+    echo -e "\033[90m------------------------------------------------------------\033[0m"
+    if [ $status -eq 0 ]; then
+        echo -e "${GREEN}✔ SUCCESS:${NC} ${GREEN}${BOLD}$title${NC}"
+        TOTAL_PASSED=$((TOTAL_PASSED + 1))
+        PASSED_CASES+=("$title")
+    else
+        echo -e "${RED}✘ FAILED (Exit Code: $status):${NC} ${RED}${BOLD}$title${NC}"
+        TOTAL_FAILED=$((TOTAL_FAILED + 1))
+        FAILED_CASES+=("$title")
+    fi
+    TOTAL_CASES=$((TOTAL_CASES + 1))
+    return $status
+}
+
+# Prints the final summary report for the demo
+function print_summary_report() {
+    local model_name="$1"
+    local model_name_upper=$(echo "$model_name" | tr '[:lower:]' '[:upper:]')
+    
+    echo -e "\n${BLUE}${BOLD}==================================================================${NC}"
+    echo -e "${BLUE}${BOLD}>>> ${model_name_upper} TEST SUMMARY${NC}"
+    echo -e "${BLUE}${BOLD}==================================================================${NC}"
+    echo -e "Total Cases Run: ${BOLD}$TOTAL_CASES${NC}"
+    echo -e "Passed:          ${GREEN}${BOLD}$TOTAL_PASSED${NC}"
+    echo -e "Failed:          ${RED}${BOLD}$TOTAL_FAILED${NC}"
+    
+    if [ $TOTAL_PASSED -gt 0 ]; then
+        echo -e "\n${GREEN}${BOLD}Passed Cases:${NC}"
+        for case in "${PASSED_CASES[@]}"; do
+            echo -e "  - ${GREEN}$case${NC}"
+        done
+    fi
+    
+    if [ $TOTAL_FAILED -gt 0 ]; then
+        echo -e "\n${RED}${BOLD}Failed Cases:${NC}"
+        for case in "${FAILED_CASES[@]}"; do
+            echo -e "  - ${RED}$case${NC}"
+        done
+        echo -e "${BLUE}${BOLD}==================================================================${NC}"
+        exit 1
+    fi
+    
+    echo -e "${GREEN}${BOLD}All ${model_name} CLI commands executed successfully!${NC}"
+    echo -e "${BLUE}${BOLD}==================================================================${NC}"
+    exit 0
+}

litert_cli/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2026 The LiteRT CLI Authors.
+#
+# 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.
+# ==============================================================================
+

litert_cli/commands/benchmark/__init__.py

@@ -0,0 +1,16 @@
+# Copyright 2026 The LiteRT CLI Authors.
+#
+# 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.
+# ==============================================================================
+
+"""CLI command for benchmarking LiteRT models."""

litert_cli/commands/benchmark/android.py

@@ -0,0 +1,212 @@
+# Copyright 2026 The LiteRT CLI Authors.
+#
+# 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.
+# ==============================================================================
+
+"""Android Benchmark Module."""
+
+from __future__ import annotations
+
+import pathlib
+import shlex
+import subprocess
+
+import click
+from litert_cli.core import android_utils
+from litert_cli.core import constants
+from litert_cli.core import npu_utils as npu
+
+
+def run_android(
+    *,
+    model_path: pathlib.Path,
+    accelerator: str,
+    num_runs: int = 50,
+    warmup_runs: int = 1,
+    min_secs: float = 1.0,
+    max_secs: float = 150.0,
+    warmup_min_secs: float = 0.5,
+    input_layer_value_range: str | None = None,
+    signature_key: str | None = None,
+) -> None:
+  """Runs the model on an Android device.
+
+  Pushes the model and benchmark_model binary to the device and runs it.
+
+  Args:
+    model_path: Path to the local LiteRT model file.
+    accelerator: Hardware accelerator to use (cpu, gpu, npu).
+    num_runs: Target number of benchmark iterations.
+    warmup_runs: Number of warmup iterations before benchmarking.
+    min_secs: Minimum seconds to run.
+    max_secs: Maximum seconds to run.
+    warmup_min_secs: Minimum warmup duration in seconds.
+    input_layer_value_range: Value range for input layers.
+    signature_key: The signature key to benchmark.
+
+  Raises:
+    subprocess.CalledProcessError: If any adb command fails on the device.
+  """
+  click.echo("Preparing to run on Android device via adb...")
+
+  android_utils.check_adb()
+  abi = android_utils.get_android_abi()
+  click.echo(f"Detected Android device ABI: {abi}")
+
+  cli_android_root = constants.LITERT_CLI_ANDROID_ROOT
+
+  model_name = model_path.name
+  remote_model_path = f"{cli_android_root}/{model_name}"
+
+  benchmark_model_bin = android_utils.find_android_binary(
+      "benchmark_model", abi
+  )
+
+  remote_dispatch_dir = ""
+  if accelerator == "npu":
+    remote_dispatch_dir = npu.push_npu_runtime_libraries(None, cli_android_root)
+
+    # Download and push SOC-specific LiteRT dispatch and compiler plugin libraries
+    target_model = npu.get_soc_target_model(None)
+    soc_vendor = "mediatek" if "mt" in target_model else "qualcomm"
+    lib_dispatch = android_utils.find_npu_dispatch_lib(soc_vendor, abi)
+    lib_compiler = android_utils.find_npu_compiler_plugin_lib(soc_vendor, abi)
+
+    remote_lib_dispatch = f"{cli_android_root}/{lib_dispatch.name}"
+    if (
+        subprocess.run(
+            ["adb", "shell", f"[ -f {remote_lib_dispatch} ]"], check=False
+        ).returncode
+        == 0
+    ):
+      click.echo(f"  Skipping {lib_dispatch.name} (already on device)")
+    else:
+      click.echo(f"Pushing {lib_dispatch.name} to device...")
+      subprocess.run(
+          ["adb", "push", str(lib_dispatch), remote_lib_dispatch], check=True
+      )
+
+    remote_lib_compiler = f"{cli_android_root}/{lib_compiler.name}"
+    if (
+        subprocess.run(
+            ["adb", "shell", f"[ -f {remote_lib_compiler} ]"], check=False
+        ).returncode
+        == 0
+    ):
+      click.echo(f"  Skipping {lib_compiler.name} (already on device)")
+    else:
+      click.echo(f"Pushing {lib_compiler.name} to device...")
+      subprocess.run(
+          ["adb", "push", str(lib_compiler), remote_lib_compiler], check=True
+      )
+
+  click.echo(f"Pushing model {model_name} to device...")
+  subprocess.run(["adb", "shell", "mkdir", "-p", cli_android_root], check=True)
+  subprocess.run(
+      ["adb", "push", str(model_path), remote_model_path], check=True
+  )
+
+  click.echo("Pushing benchmark_model to device...")
+  subprocess.run(
+      [
+          "adb",
+          "push",
+          str(benchmark_model_bin),
+          f"{cli_android_root}/benchmark_model",
+      ],
+      check=True,
+  )
+  subprocess.run(
+      ["adb", "shell", "chmod", "+x", f"{cli_android_root}/benchmark_model"],
+      check=True,
+  )
+
+  click.echo("Executing benchmark on device...\n")
+  try:
+    bench_args = [
+        f"{cli_android_root}/benchmark_model",
+        f"--graph={shlex.quote(remote_model_path)}",
+    ]
+    if accelerator == "gpu":
+      bench_args.append("--use_gpu=true")
+    elif accelerator == "npu":
+      bench_args.append("--use_npu=true")
+      bench_args.append(f"--dispatch_library_path={shlex.quote(cli_android_root)}")
+      bench_args.append(
+          f"--compiler_plugin_library_path={shlex.quote(cli_android_root)}"
+      )
+
+      if soc_vendor == "mediatek":
+        recommend_version = constants.MEDIATEK_SOC_VERSION_MAP.get(
+            target_model, ""
+        )
+        if "v9" in recommend_version:
+          bench_args.append("--mediatek_nerun_pilot_version=version9")
+        elif "v8" in recommend_version:
+          bench_args.append("--mediatek_nerun_pilot_version=version8")
+
+    if num_runs != 50:
+      bench_args.append(f"--num_runs={num_runs}")
+    if warmup_runs != 1:
+      bench_args.append(f"--warmup_runs={warmup_runs}")
+    if min_secs != 1.0:
+      bench_args.append(f"--min_secs={min_secs}")
+    if max_secs != 150.0:
+      bench_args.append(f"--max_secs={max_secs}")
+    if warmup_min_secs != 0.5:
+      bench_args.append(f"--warmup_min_secs={warmup_min_secs}")
+    if input_layer_value_range:
+      bench_args.append(
+          f"--input_layer_value_range={shlex.quote(input_layer_value_range)}"
+      )
+    if signature_key:
+      bench_args.append(f"--signature_to_run_for={shlex.quote(signature_key)}")
+
+    env_vars = ""
+    if remote_dispatch_dir:
+      quoted_dispatch_dir = shlex.quote(remote_dispatch_dir)
+      env_vars = (
+          f"LD_LIBRARY_PATH={quoted_dispatch_dir} "
+          f"ADSP_LIBRARY_PATH={quoted_dispatch_dir} "
+      )
+
+    full_command = env_vars + " ".join(bench_args)
+    process = subprocess.Popen(
+        ["adb", "shell", full_command],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        text=True,
+    )
+
+    from litert_cli.core.log_filters import BenchmarkLogFilter
+
+    output_lines = []
+    log_filter = BenchmarkLogFilter(constants.DEFAULT_QUIET)
+
+    for line in process.stdout:
+      output_lines.append(line)
+      if log_filter.should_show(line):
+        click.echo(line, nl=False)
+
+    process.wait()
+    if process.returncode != 0:
+      click.secho(
+          f"Execution failed on device with exit code {process.returncode}",
+          fg="red",
+      )
+      click.echo("Full output for debugging:")
+      for line in output_lines:
+        click.echo(line, nl=False)
+      raise click.ClickException("Benchmark failed on device.")
+  except Exception as e:
+    raise click.ClickException(f"Failed to execute benchmark on device: {e}")