ls-algorithm-plugin-sdk 0.2.5__py3-none-any.whl

algorithm_plugin_sdk/webui/app.css

@@ -0,0 +1,49 @@
+:root {
+  color-scheme: light;
+  font-family: Inter, ui-sans-serif, system-ui, sans-serif;
+  color: #202522;
+  background: #f1f3ef;
+  --border: #d8ddd7;
+  --muted: #68716b;
+  --accent: #116149;
+}
+
+* { box-sizing: border-box; }
+body { margin: 0; }
+main { width: min(960px, calc(100% - 32px)); margin: 40px auto 80px; }
+header { margin-bottom: 24px; }
+h1, h2, p { margin-top: 0; }
+h1 { margin-bottom: 8px; font-size: clamp(2rem, 6vw, 3.4rem); letter-spacing: -.05em; }
+h2 { margin-bottom: 0; font-size: 1.1rem; }
+.eyebrow { margin-bottom: 8px; color: var(--accent); font-size: .75rem; font-weight: 800; letter-spacing: .16em; }
+.muted { color: var(--muted); }
+.mono, pre { font-family: ui-monospace, SFMono-Regular, Menlo, monospace; }
+.panel { margin-top: 16px; padding: 24px; border: 1px solid var(--border); border-radius: 14px; background: #fff; box-shadow: 0 8px 28px rgba(24, 38, 29, .05); }
+.section-heading, .actions { display: flex; align-items: center; justify-content: space-between; gap: 12px; }
+.grid { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 14px; }
+label { display: grid; gap: 7px; margin-top: 16px; color: #414943; font-size: .84rem; font-weight: 650; }
+input, textarea { width: 100%; padding: 10px 12px; border: 1px solid #cbd2cc; border-radius: 8px; background: #fbfcfa; color: inherit; font: inherit; }
+input:focus, textarea:focus { outline: 2px solid rgba(17, 97, 73, .22); border-color: var(--accent); }
+button { padding: 10px 15px; border: 0; border-radius: 8px; background: var(--accent); color: #fff; font: inherit; font-weight: 700; cursor: pointer; }
+button:disabled { cursor: not-allowed; opacity: .45; }
+button.secondary { padding: 7px 10px; border: 1px solid var(--border); background: #fff; color: #414943; }
+button.danger { background: #a63d34; }
+.actions { justify-content: flex-start; margin-top: 20px; }
+.check { display: flex; align-items: center; }
+.check input { width: auto; }
+.input-card { margin: 14px 0 0; padding: 16px; border: 1px solid var(--border); border-radius: 10px; }
+.badge { padding: 5px 9px; border-radius: 999px; background: #e7eee9; color: var(--accent); font-size: .78rem; font-weight: 800; }
+.dataset { margin-top: 16px; padding-top: 16px; border-top: 1px solid var(--border); }
+.progress-row { display: grid; grid-template-columns: minmax(120px, 1fr) 2fr 72px 110px; align-items: center; gap: 10px; margin-top: 9px; font-size: .86rem; }
+.episode { padding-left: 22px; color: #4f5852; }
+progress { width: 100%; accent-color: var(--accent); }
+pre { overflow: auto; max-height: 460px; margin-bottom: 0; padding: 16px; border-radius: 8px; background: #18201b; color: #e9f0eb; font-size: .8rem; }
+#message.error { color: #a63d34; }
+
+@media (max-width: 680px) {
+  main { margin-top: 24px; }
+  .panel { padding: 18px; }
+  .grid { grid-template-columns: 1fr; gap: 0; }
+  .progress-row { grid-template-columns: 1fr 72px; }
+  .progress-row progress { grid-column: 1 / -1; grid-row: 2; }
+}

algorithm_plugin_sdk/webui/app.js

@@ -0,0 +1,197 @@
+const elements = {
+  form: document.querySelector("#run-form"),
+  inputs: document.querySelector("#inputs"),
+  addInput: document.querySelector("#add-input"),
+  outputDir: document.querySelector("#output-dir"),
+  pluginToken: document.querySelector("#plugin-token"),
+  parameters: document.querySelector("#parameters"),
+  merge: document.querySelector("#merge"),
+  mergeWrap: document.querySelector("#merge-wrap"),
+  run: document.querySelector("#run"),
+  cancel: document.querySelector("#cancel"),
+  message: document.querySelector("#message"),
+  metadata: document.querySelector("#metadata"),
+  progressPanel: document.querySelector("#progress-panel"),
+  progress: document.querySelector("#progress"),
+  executionState: document.querySelector("#execution-state"),
+  executionId: document.querySelector("#execution-id"),
+  resultPanel: document.querySelector("#result-panel"),
+  result: document.querySelector("#result"),
+  template: document.querySelector("#input-template"),
+};
+
+let metadata;
+let activeExecution;
+let pollGeneration = 0;
+
+function setMessage(message = "", error = false) {
+  elements.message.textContent = message;
+  elements.message.classList.toggle("error", error);
+}
+
+function addInput(values = {}) {
+  const fragment = elements.template.content.cloneNode(true);
+  const card = fragment.querySelector(".input-card");
+  const fields = fragment.querySelector(".input-fields");
+  for (const [name, descriptor] of Object.entries(metadata.inputPaths || {})) {
+    const label = document.createElement("label");
+    label.textContent = name;
+    const input = document.createElement("input");
+    input.dataset.pathName = name;
+    input.value = values[name] || "";
+    input.required = Boolean(descriptor.required);
+    input.placeholder = descriptor.description || descriptor.type || "Path";
+    label.append(input);
+    fields.append(label);
+  }
+  fragment.querySelector(".remove").addEventListener("click", () => {
+    if (elements.inputs.children.length > 1) card.remove();
+  });
+  elements.inputs.append(fragment);
+}
+
+function requestBody() {
+  const parameters = JSON.parse(elements.parameters.value || "{}");
+  if (!parameters || Array.isArray(parameters) || typeof parameters !== "object") {
+    throw new Error("Parameters must be a JSON object");
+  }
+  const inputs = [...elements.inputs.querySelectorAll(".input-card")].map((card) =>
+    Object.fromEntries(
+      [...card.querySelectorAll("[data-path-name]")]
+        .map((input) => [input.dataset.pathName, input.value.trim()])
+        .filter(([, value]) => value),
+    ),
+  );
+  return { inputs, outputDir: elements.outputDir.value.trim(), parameters, merge: elements.merge.checked };
+}
+
+async function api(path, options) {
+  const headers = new Headers(options?.headers || {});
+  const token = elements.pluginToken?.value.trim();
+  if (token) headers.set("X-LDP-Plugin-Token", token);
+  const response = await fetch(path, { ...(options || {}), headers });
+  let body;
+  try { body = await response.json(); } catch { body = {}; }
+  if (!response.ok) throw new Error(body.error || `Request failed (${response.status})`);
+  return body;
+}
+
+function progressRow(name, item, episode = false) {
+  const row = document.createElement("div");
+  row.className = `progress-row${episode ? " episode" : ""}`;
+  const title = document.createElement("span");
+  title.textContent = name;
+  title.title = name;
+  const bar = document.createElement("progress");
+  bar.max = 100;
+  if (item.percent != null) bar.value = item.percent;
+  const percent = document.createElement("span");
+  percent.textContent = item.percent == null ? "—" : `${item.percent.toFixed(1)}%`;
+  const stage = document.createElement("span");
+  stage.textContent = item.message || item.stage || item.status;
+  row.append(title, bar, percent, stage);
+  return row;
+}
+
+function renderProgress(snapshot) {
+  elements.progress.replaceChildren();
+  if (!snapshot) return;
+  for (const [name, dataset] of Object.entries(snapshot.datasets || {})) {
+    const block = document.createElement("div");
+    block.className = "dataset";
+    block.append(progressRow(name, dataset));
+    for (const [episode, progress] of Object.entries(dataset.episodes || {})) {
+      block.append(progressRow(episode, progress, true));
+    }
+    elements.progress.append(block);
+  }
+}
+
+async function finishExecution(executionId, generation) {
+  if (generation !== pollGeneration) return;
+  const status = await api(`/v1/executions/${encodeURIComponent(executionId)}`);
+  elements.executionState.textContent = status.state;
+  renderProgress(status.progress);
+  const result = await api(`/v1/executions/${encodeURIComponent(executionId)}/result`);
+  elements.result.textContent = JSON.stringify(result, null, 2);
+  elements.resultPanel.hidden = false;
+  elements.run.disabled = false;
+  elements.cancel.disabled = true;
+  activeExecution = undefined;
+}
+
+async function poll(executionId, generation, sequence = 0) {
+  while (generation === pollGeneration) {
+    try {
+      const payload = await api(`/v1/executions/${encodeURIComponent(executionId)}/events?afterSequence=${sequence}&waitSeconds=20`);
+      if (generation !== pollGeneration) return;
+      sequence = payload.nextSequence;
+      if (payload.events.length) renderProgress(payload.events.at(-1));
+      if (payload.terminal) return await finishExecution(executionId, generation);
+    } catch (error) {
+      if (generation !== pollGeneration) return;
+      setMessage(error.message, true);
+      await new Promise((resolve) => setTimeout(resolve, 1000));
+    }
+  }
+}
+
+elements.addInput.addEventListener("click", () => addInput());
+elements.form.addEventListener("submit", async (event) => {
+  event.preventDefault();
+  try {
+    setMessage("Submitting…");
+    const accepted = await api("/v1/executions", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(requestBody()),
+    });
+    activeExecution = accepted.executionId;
+    pollGeneration += 1;
+    elements.run.disabled = true;
+    elements.cancel.disabled = false;
+    elements.progressPanel.hidden = false;
+    elements.resultPanel.hidden = true;
+    elements.executionId.textContent = activeExecution;
+    elements.executionState.textContent = accepted.state;
+    elements.progress.replaceChildren();
+    setMessage("");
+    poll(activeExecution, pollGeneration);
+  } catch (error) {
+    setMessage(error.message, true);
+  }
+});
+
+elements.cancel.addEventListener("click", async () => {
+  if (!activeExecution) return;
+  try {
+    elements.cancel.disabled = true;
+    await api(`/v1/executions/${encodeURIComponent(activeExecution)}:cancel`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ reason: "cancelled from WebUI" }),
+    });
+    setMessage("Cancellation requested");
+  } catch (error) {
+    elements.cancel.disabled = false;
+    setMessage(error.message, true);
+  }
+});
+
+async function initialize() {
+  try {
+    metadata = await api("/v1/metadata");
+    elements.metadata.textContent = `${metadata.name} ${metadata.version}${metadata.description ? ` — ${metadata.description}` : ""}`;
+    elements.mergeWrap.hidden = !metadata.supportsMerge;
+    const defaults = Object.fromEntries(
+      Object.entries(metadata.parameters || {}).filter(([, descriptor]) => descriptor && Object.hasOwn(descriptor, "default")).map(([name, descriptor]) => [name, descriptor.default]),
+    );
+    elements.parameters.value = JSON.stringify(defaults, null, 2);
+    addInput();
+  } catch (error) {
+    setMessage(`Cannot load metadata: ${error.message}`, true);
+    elements.run.disabled = true;
+  }
+}
+
+initialize();

algorithm_plugin_sdk/webui/index.html

@@ -0,0 +1,62 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Algorithm Processing</title>
+    <link rel="stylesheet" href="/ui/app.css">
+  </head>
+  <body>
+    <main>
+      <header>
+        <p class="eyebrow">INTERNAL TOOL</p>
+        <h1>Algorithm Processing</h1>
+        <p id="metadata" class="muted">Loading algorithm metadata…</p>
+      </header>
+
+      <section class="panel">
+        <form id="run-form">
+          <div class="section-heading">
+            <h2>Inputs</h2>
+            <button id="add-input" type="button" class="secondary">Add dataset</button>
+          </div>
+          <div id="inputs"></div>
+
+          <div class="grid">
+            <label>Output directory<input id="output-dir" required placeholder="/data/output"></label>
+          </div>
+          <label>Plugin token (when required)<input id="plugin-token" type="password" autocomplete="off"></label>
+          <label>Parameters (JSON)<textarea id="parameters" rows="5">{}</textarea></label>
+          <label id="merge-wrap" class="check"><input id="merge" type="checkbox"> Merge results</label>
+
+          <div class="actions">
+            <button id="run" type="submit">Run dataset</button>
+            <button id="cancel" type="button" class="danger" disabled>Cancel</button>
+            <span id="message" role="status"></span>
+          </div>
+        </form>
+      </section>
+
+      <section id="progress-panel" class="panel" hidden>
+        <div class="section-heading">
+          <h2>Progress</h2>
+          <span id="execution-state" class="badge">accepted</span>
+        </div>
+        <p id="execution-id" class="mono muted"></p>
+        <div id="progress"></div>
+      </section>
+
+      <section id="result-panel" class="panel" hidden>
+        <h2>Result</h2>
+        <pre id="result"></pre>
+      </section>
+    </main>
+    <template id="input-template">
+      <fieldset class="input-card">
+        <div class="section-heading"><strong>Dataset</strong><button type="button" class="remove secondary">Remove</button></div>
+        <div class="input-fields grid"></div>
+      </fieldset>
+    </template>
+    <script src="/ui/app.js" defer></script>
+  </body>
+</html>

algorithm_plugin_sdk/webui_app.py

@@ -0,0 +1,43 @@
+"""Optional internal WebUI mounted on the generic HTTP service."""
+
+from __future__ import annotations
+
+from importlib import resources
+from typing import Any
+
+
+def mount_webui(application: Any, *, webui_url: str | None = None) -> None:
+    """Mount the internal WebUI routes on a FastAPI application."""
+    from fastapi.responses import JSONResponse, RedirectResponse, Response
+
+    webui_root = resources.files("algorithm_plugin_sdk.webui")
+
+    def webui_asset(name: str, media_type: str) -> Response:
+        content = webui_root.joinpath(name).read_bytes()
+        return Response(content=content, media_type=media_type)
+
+    @application.get("/ui", include_in_schema=False)
+    def redirect_webui() -> RedirectResponse:
+        return RedirectResponse("/ui/")
+
+    @application.get("/ui/", include_in_schema=False)
+    def webui_index() -> Response:
+        return webui_asset("index.html", "text/html")
+
+    @application.get("/ui/app.css", include_in_schema=False)
+    def webui_css() -> Response:
+        return webui_asset("app.css", "text/css")
+
+    @application.get("/ui/app.js", include_in_schema=False)
+    def webui_js() -> Response:
+        return webui_asset("app.js", "text/javascript")
+
+    if webui_url:
+        application.state.webui_url = webui_url
+
+
+def announce_webui(application: Any) -> None:
+    """Print the WebUI address after the application lifespan starts."""
+    webui_url = getattr(application.state, "webui_url", None)
+    if webui_url:
+        print(f"WebUI started: {webui_url}", flush=True)

ls_algorithm_plugin_sdk-0.2.5.dist-info/METADATA

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: ls-algorithm-plugin-sdk
+Version: 0.2.5
+Summary: Protocol-independent runtime SDK for dataset algorithms
+Author: Ling Robotics
+License: Proprietary
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Provides-Extra: service
+Requires-Dist: fastapi<1,>=0.110; extra == "service"
+Requires-Dist: pydantic<3,>=2.0; extra == "service"
+Requires-Dist: uvicorn[standard]<1,>=0.29; extra == "service"
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+
+# Algorithm Plugin SDK
+
+算法仓库只实现一个 `Algorithm` 类并声明 entry point。SDK
+统一提供单次运行、WebUI、HTTP service、release manifest、compute 注册、心跳以及裸机进程管理。
+算法仓库不需要 Dockerfile、Web 框架代码或 service 启停脚本。
+
+## 算法侧最小接口
+
+```python
+from algorithm_plugin_sdk import Algorithm
+
+class MyAlgorithm(Algorithm):
+    @classmethod
+    def metadata(cls): ...
+    def execute(self, request, context): ...
+```
+
+算法包声明 `algorithm_plugin_sdk.algorithms` entry point，并在仓库根目录发布只读的
+`release-manifest.json`。同一个 `execute()` 会被所有运行方式复用。
+
+## 单次运行
+
+```bash
+algorithm-plugin run camera-space-mano \
+  --input '{"dataset":"/data/input"}' \
+  --output-dir /data/output
+```
+
+## 一次生成、一次启动、一次停止
+
+在算法仓库根目录执行：
+
+```bash
+algorithm-plugin config \
+  --compute-url http://compute:5180 \
+  --api-key "$LDP_INTERNAL_API_KEY" \
+  --public-url http://10.0.0.4:9000 \
+  --input-root /data/jobs/input \
+  --workspace-root /data/jobs/workspace \
+  --cluster production \
+  --namespace camera-space-mano \
+  --node-name 10.0.0.4 \
+  --gpu-ids 0
+
+algorithm-plugin start
+algorithm-plugin stop
+```
+
+`gpu_ids` 属于部署配置，不由 `/v1/executions` 请求提供。SDK 启动服务后会将配置的
+GPU IDs 自动注入每个 `AlgorithmRequest`。
+
+`config` 自动发现当前仓库和唯一 Algorithm entry point，并从 `release-manifest.json`
+补齐 algorithm type、version、implementation digest、build revision、schema、启动入口、
+PID 和日志路径。生成的 `algorithm-plugin.json` 权限为 `0600`。开发环境可使用
+`algorithm-plugin config --local` 跳过 compute 注册。
+
+`start` 默认在后台启动 `0.0.0.0:9000`，同时提供 `/ui/` 和 `/v1/*`，自动注册并每
+5 秒心跳。日志写到 `.algorithm-plugin/service.log`。`stop` 只终止 PID、启动时间和命令行
+均匹配当前配置的 SDK 进程，避免误杀复用 PID 的其他进程。
+
+需要前台运行（例如 systemd）时仍可使用：
+
+```bash
+algorithm-plugin serve camera-space-mano --port 9000 --webui
+```
+
+## 安装与测试
+
+```bash
+python -m pip install '.[service]'
+python -m unittest discover -s tests -v
+```

ls_algorithm_plugin_sdk-0.2.5.dist-info/RECORD

@@ -0,0 +1,25 @@
+algorithm_plugin_sdk/__init__.py,sha256=OKj2VcNXTwZmRgPlECI6QUBlxW1YLtflr4RAgs6w064,1223
+algorithm_plugin_sdk/algorithm.py,sha256=INjX-ygMQfHk8D1AZbEEdCw1P4VNQLGF989lP1J1H1k,1025
+algorithm_plugin_sdk/cli.py,sha256=1BW4LhOq-5EBbVpZ6gDLJAFozYSygaB-IXkExWIQ_Lk,19814
+algorithm_plugin_sdk/context.py,sha256=Kj-eDZg7PgX6xNzrWrQs37UfepTP8fXv4_8hCgsAIDA,11016
+algorithm_plugin_sdk/deployment.py,sha256=pmw3k4BSYN-ugWtxLX3vrsAfOwRfv529uwgc9qW7Pt8,12885
+algorithm_plugin_sdk/errors.py,sha256=DNmI2c36Pd7K6tTaonqfEgpBzwX0o6pXzYrc8r2Z--k,730
+algorithm_plugin_sdk/loader.py,sha256=XKmyqbJMoUMdKoo2eRQFGdbsmlz6NBgtUeIdqzumJFs,2561
+algorithm_plugin_sdk/models.py,sha256=KHRHqxp267frwvOdoxyISHb6Ytam51FIT7dsME2ends,12490
+algorithm_plugin_sdk/registration.py,sha256=s5oQkf12_uRjdA4CYMYM8SDQjhsk1rzDDF-3w36U_lA,10474
+algorithm_plugin_sdk/release.py,sha256=qQSz913f89nnsHeQwTZ1U9od42yTPJeRNCGGBn1xqX0,6458
+algorithm_plugin_sdk/runner.py,sha256=QKZEPRW2O6BqNgfp7x2sILDMQU1PYRrtHRWFkuaBhFM,4035
+algorithm_plugin_sdk/service.py,sha256=0-8yLrM9-AolO98rD_lcGOm8HGbnEJ5DJCUQxwyPfSo,24048
+algorithm_plugin_sdk/webui_app.py,sha256=Gvt2FPt0xZBjYi39sqTQqcosllifYeJam49_mGfkEVw,1530
+algorithm_plugin_sdk/examples/__init__.py,sha256=WxZZzUzxKhqZg3KibVY-7CB960DNjt6IfjciZ8JXbq0,57
+algorithm_plugin_sdk/examples/example_algorithm.py,sha256=XySYNMfgch-24dreNSI7R4fcT5ZhBpL8YaNFsv62hCM,3775
+algorithm_plugin_sdk/examples/simulated_algorithm.py,sha256=L4OYUmkbOu6-M97aCTSwJFFQ-3pqhc3Z57pkry6w5VE,2938
+algorithm_plugin_sdk/webui/__init__.py,sha256=cvtaktJXz_DYG4QbV5ppoqY2bFaMLuiUcTBKA33emx0,61
+algorithm_plugin_sdk/webui/app.css,sha256=5HGDKlbUFLZMgCknlRuwCjiNcCr8poIF5YGHchyaamE,2965
+algorithm_plugin_sdk/webui/app.js,sha256=0YsXsocEY3yDseG3jh0RhzI8xo_bYmsbSxdN3FdCswQ,7657
+algorithm_plugin_sdk/webui/index.html,sha256=hsTTMxOoTygBHF0QaAQA3SVVJJLidTNo2cyrtVVzLYE,2253
+ls_algorithm_plugin_sdk-0.2.5.dist-info/METADATA,sha256=WWYGTazf1JWiwWo4PRgpqRHt2UMrFybsUptuXAaOrzk,2809
+ls_algorithm_plugin_sdk-0.2.5.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+ls_algorithm_plugin_sdk-0.2.5.dist-info/entry_points.txt,sha256=TU0R_TxuB5OuOiZ5BHOEmUPtHvN3v8ARUW8d3PztHcE,67
+ls_algorithm_plugin_sdk-0.2.5.dist-info/top_level.txt,sha256=8lsgxZ8HJGLlzJ5Rt8CiVzw9Ccme286i3akbmeMjBos,21
+ls_algorithm_plugin_sdk-0.2.5.dist-info/RECORD,,

ls_algorithm_plugin_sdk-0.2.5.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ls_algorithm_plugin_sdk-0.2.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+algorithm-plugin = algorithm_plugin_sdk.cli:main

ls_algorithm_plugin_sdk-0.2.5.dist-info/top_level.txt

@@ -0,0 +1 @@
+algorithm_plugin_sdk