omni-train-cli 0.1.29__tar.gz

omni_train_cli-0.1.29/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: omni-train-cli
+Version: 0.1.29
+Summary: CLI and agent Skill for Omni Train
+Requires-Python: <3.13,>=3.9
+Requires-Dist: httpx<1,>=0.28
+Requires-Dist: PyYAML<7,>=6.0
+Requires-Dist: keyring<26,>=25
+Requires-Dist: tomli<3,>=2.0; python_version < "3.11"

omni_train_cli-0.1.29/README.md

@@ -0,0 +1,201 @@
+# Omni Train CLI
+
+Python support: 3.9 through 3.12. Python 3.9 and 3.10 install the small
+`tomli` compatibility dependency automatically.
+
+Install the internal Wheel with:
+
+```powershell
+uv tool install omni-train-cli --index-url https://pypi.company.example/simple
+```
+
+For an offline release:
+
+```powershell
+uv tool install .\omni_train_cli-0.1.25-py3-none-any.whl
+```
+
+On Debian/Ubuntu, do not install the Wheel into the system Python with
+`pip install`. Those distributions enable PEP 668 and mark the environment as
+externally managed. Use one of the isolated installation methods instead:
+
+```bash
+# Recommended for a command-line application
+pipx install ./omni_train_cli-0.1.25-py3-none-any.whl
+
+# Or use a project virtual environment
+python3 -m venv .venv
+. .venv/bin/activate
+python -m pip install ./omni_train_cli-0.1.25-py3-none-any.whl
+
+# If uv is available
+uv tool install ./omni_train_cli-0.1.25-py3-none-any.whl
+```
+
+If `pipx` is not installed, install it with the OS package manager first (for
+example, `sudo apt install pipx`) and then run `pipx ensurepath`. Avoid
+`--break-system-packages` unless the machine is disposable and you explicitly
+accept the risk of modifying the system Python.
+
+Configure the platform and personal scoped API Key:
+
+```powershell
+omni config set endpoint https://omni.company.example
+omni auth set-key
+omni context show --output json
+omni skill install
+```
+
+`org_id` is optional. When omitted, the API uses the account's default
+Workspace. List accessible Workspaces, persist a selection, or restore the
+default with:
+
+```powershell
+omni workspace list --output json
+omni workspace use <workspace_id> --output json
+omni workspace reset --output json
+```
+
+The CLI validates a Workspace before persisting it. Global `--org-id` remains
+a one-command override. If `OMNI_ORG_ID` is set, unset it before running
+`workspace use` or `workspace reset`, because the environment variable has
+higher priority than the saved profile.
+
+When `--target` is omitted, the CLI installs the Skill into the shared Agent
+Skills directory (`~/.agents/skills`). Tools that support the Agent Skills
+standard can discover it from there. Use an explicit target when a tool-specific
+personal directory is preferred:
+
+- Shared Agent Skills (default): `~/.agents/skills`
+- GitHub Copilot: `~/.copilot/skills` (or `$COPILOT_HOME/skills` when `COPILOT_HOME` is set)
+- Codex: `%USERPROFILE%\.codex\skills` (or `%CODEX_HOME%\skills` when `CODEX_HOME` is set)
+- Claude Code: `%USERPROFILE%\.claude\skills`
+- Platform: `.omni-skills` in the current directory
+
+```powershell
+omni skill install --target copilot
+omni skill install --target codex
+omni skill install --target claude-code
+```
+
+`--destination` overrides the selected target's default Skill directory.
+
+Automation uses `OMNI_API_KEY` instead of storing a Key in the profile. Training is declared in `train.yaml`; validate it with `omni train validate` and submit it with `omni train submit`.
+
+Detailed training output is available with
+`omni train logs <run_id> --log-type client --output json` (`client` is the
+default). Use `--log-type task` for workflow-stage messages or
+`--log-type all` for separate snapshots of both streams. Log paging supports
+`--offset` and `--limit`; `--follow` follows one `client` or `task` stream.
+
+List commands support pagination:
+
+```powershell
+omni dataset list --page 2 --page-size 50
+omni algorithm list --available --page-size 50
+omni task list --page-size 50
+omni train list --all
+```
+
+Use `--all` to request the complete result set (`page_size=all`).
+
+Create a private dataset and upload a local ZIP into a new subset with TUS
+resumable upload:
+
+```powershell
+omni dataset create --name demo-dataset --type classification --labels cat,dog --output json
+omni dataset upload .\dataset.zip --dataset-id 25 --subset-name train --output json
+```
+
+Run the same upload command again after an interruption to resume from the
+server offset. Add `--wait --timeout 1800` only when the command must wait for
+background parsing. The output reports file upload and dataset parsing as
+separate states. Personal API Keys need the `dataset` scope for creation and
+upload.
+
+Upload a custom algorithm package and submit its build in one command. The ZIP
+must contain exactly one top-level directory with the six required files from
+the custom algorithm specification:
+
+```powershell
+omni algorithm base-images --output json
+
+omni algorithm upload `
+  --name demo-classifier `
+  --type classification `
+  --archive .\algorithm.zip `
+  --output json
+```
+
+To upload a new build to an existing algorithm, replace `--name` and `--type`
+with `--algorithm-id <id>`. The command creates the algorithm when needed,
+uploads the archive, and submits the platform build workflow. `--params-file`
+can be used to provide the algorithm's custom parameter object in YAML or JSON.
+The CLI reads available images from the platform. When `--base-image` is
+omitted, it uses the option marked as the platform default; an explicitly
+provided value is validated against the same list.
+
+For Skill-generated image algorithms, start from
+`assets/algorithm.params.example.yaml`, save it as `algorithm.params.yaml`, and
+pass it explicitly with `--params-file`. The template declares the base
+`epochs`, `batch_size`, and `input_size` controls plus recommended `train`
+custom parameters such as `lr` and `optimizer`. The CLI does not discover this
+file inside the ZIP automatically.
+
+When `--algorithm-id` and `--params-file` are used together, the CLI updates
+the existing algorithm parameters through the standard algorithm PATCH before
+uploading the archive. Without `--params-file`, existing parameters remain
+unchanged.
+
+The upload response includes `algorithm_id` and `build_id`. Query the build
+list, status, and logs with:
+
+```powershell
+omni algorithm builds 27 --all --output json
+omni algorithm build-status 27 103 --output json
+omni algorithm build-logs 27 103 --offset 0 --limit 200 --output json
+```
+
+Personal API Keys need the `train` scope for algorithm creation, source
+upload, build listing, status, and log queries.
+
+Deploy a completed training model by first listing the platform targets, then
+using a deployment configuration:
+
+```powershell
+omni deploy platforms --output json
+omni deploy submit --file .\deploy.yaml --output json
+omni deploy status 12 --output json
+omni deploy logs 12 --offset 0 --limit 200 --output json
+omni deploy wait 12 --output json
+omni deploy download 12 --output-path .\artifacts\deployed-model.zip --output json
+omni deploy sdk 12 --output-path .\artifacts\omni-sdk.zip --output json
+```
+
+`deploy submit --file` creates and starts the workflow. Use
+`deploy create --file` for a create-only record, then start it with
+`deploy submit --deploy-id <id>`. Stop and delete remain separate explicit
+commands. Personal API Keys need the `deploy` scope for the deployment
+lifecycle. SDK download always uses the deployment's stored system and
+platform; the CLI does not accept target overrides.
+
+Update resources without changing lifecycle state:
+
+```powershell
+omni algorithm update 27 --file .\algorithm-update.yaml --output json
+omni project list --all --output json
+omni project update 45 --file .\project-update.yaml --output json
+omni train update 53 --file .\train.yaml --output json
+omni deploy update 12 --file .\deploy.yaml --output json
+```
+
+Algorithm updates are limited to `name`, `description`, `type`, and `params`;
+upload a new ZIP separately when source code changes. Project type is
+immutable. Training and deployment configuration can be updated only while
+their status is `new`. These commands do not submit, start, stop, delete, or
+rebuild a resource.
+
+The underlying REST mapping keeps standard partial-update routes for
+algorithms, projects, and training tasks (`/api/algorithms/{id}`,
+`/api/trains/{id}`, and `/api/models/{id}`). Only deployment configuration
+uses the dedicated `/api/deploys/{id}/config` endpoint.

omni_train_cli-0.1.29/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "omni-train-cli"
+version = "0.1.29"
+description = "CLI and agent Skill for Omni Train"
+requires-python = ">=3.9,<3.13"
+dependencies = [
+    "httpx>=0.28,<1",
+    "PyYAML>=6.0,<7",
+    "keyring>=25,<26",
+    "tomli>=2.0,<3; python_version < '3.11'",
+]
+
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project.scripts]
+omni = "omni_cli.main:main"
+omni-train-cli = "omni_cli.main:main"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+
+[dependency-groups]
+dev = ["pytest>=8,<9"]
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+omni_cli = [
+    "bundled_skills/omni-train/*",
+    "bundled_skills/omni-train/references/*",
+    "bundled_skills/omni-train/assets/*",
+]

omni_train_cli-0.1.29/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

omni_train_cli-0.1.29/src/omni_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.29"

omni_train_cli-0.1.29/src/omni_cli/__main__.py

@@ -0,0 +1,5 @@
+from .main import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

omni_train_cli-0.1.29/src/omni_cli/bundled_skills/omni-train/SKILL.md

@@ -0,0 +1,194 @@
+---
+name: omni-train
+description: Use when operating Omni Train through the CLI, preparing custom image algorithm packages, or running dataset, training, deployment, and algorithm build workflows.
+---
+
+# Omni Train agent workflow
+
+Use the `omni` CLI as the only platform interface. Use `--output json` for every command and make decisions from the JSON envelope and exit code.
+
+1. Run `omni context show --output json` before platform work.
+   When the user has not selected a Workspace, keep the account's default Workspace
+   and do not persist an override. When the user asks which
+   Workspaces are available, run `omni workspace list --output json`. Only
+   switch after an explicit user request, using
+   `omni workspace use <workspace_id> --output json`; never guess a Workspace ID.
+   Restore the account default with
+   `omni workspace reset --output json`.
+2. Discover real dataset, task, and algorithm IDs with `omni dataset`, `omni task`, and `omni algorithm`; never guess IDs. Use `omni task list --page`, `--page-size`, or `--all` when the task list is paginated.
+   Use `--page`, `--page-size`, or `--all` when a list response is paginated.
+   When the user needs a new dataset, run
+   `omni dataset create --name <name> --type <type> --labels <label1,label2> --output json`
+   and retain the returned `dataset_id`. To upload a local ZIP, run
+   `omni dataset upload <archive.zip> --dataset-id <dataset_id> --subset-name <subset> --output json`.
+   This command creates the dataset subset and uses persistent TUS resumable
+   upload state. Keep resume enabled by default; use `--restart` only when the
+   user explicitly asks to discard the current upload session. File upload
+   completion is not dataset parsing completion. Use `--wait` only when the
+   user asks to wait for parsing, and report the returned upload and parse
+   states separately.
+   When the user explicitly says the ZIP contains LabelMe annotations, add
+   `--labeled-format json`. Each annotated image must have a `.json` file in
+   the same directory with the same filename stem. When a classification ZIP
+   is organized by label directory, add `--labeled-format folder`; every image
+   must be below a directory whose name exactly matches an existing dataset
+   label. The target must be a classification dataset using tag annotations.
+   A single common wrapper directory is allowed. Do not infer labeled mode
+   from ZIP contents when the user has not declared it.
+3. Read the selected algorithm's `params` from
+   `omni algorithm get <algorithm_id> --output json`, then create `train.yaml`
+   using `references/train-schema.md`. Standard training defaults are declared
+   under `params.base`. When the user does not specify `epochs`, `batch_size`,
+   or `input_size`, omit those fields instead of inventing values; the CLI
+   applies the selected algorithm's defaults. Put custom overrides under
+   `configuration.advanced_conf.<stage>` using only stages and keys declared
+   by that algorithm. Never guess a custom parameter name.
+   For `dataset.splits`, follow the split rules in `references/train-schema.md`:
+   a single subtask uses ratio split and defaults to 8:2 (`0.8`/`0.2`) when
+   `train`/`val` are omitted. With multiple subtasks, ask the user whether to
+   use ratio split (fractions on every subtask) or independent split
+   (`mode: independent` with `1`/`0`, naming which subtasks are train and which
+   are val); do not guess the strategy.
+4. Run `omni train validate --file train.yaml --output json`.
+5. Run `omni train create --file train.yaml --output json` and retain
+   `train_id`, `run_id`, and `invocation_id`.
+6. By default, create and start it without pausing for confirmation. Immediately
+   run `omni train submit --run-id <run_id> --output json` after a successful
+   creation. Only stop after creation when the user explicitly asks for
+   create-only, no start, a draft, or inspection before starting.
+7. Wait only when requested with `omni train wait <run_id>`. Do not poll indefinitely.
+8. Diagnose failures with `omni train status <run_id> --output json` and
+   `omni train logs <run_id> --log-type client --output json`. The `client`
+   log is the default and contains detailed training output such as per-epoch
+   metrics. Use `--log-type task` for workflow-stage messages and
+   `--log-type all` for a snapshot of both streams. Add `--follow` only to a
+   single `client` or `task` stream.
+9. Run `omni train stop <run_id>` only after the user explicitly asks to stop.
+10. On completion, use `omni train result <run_id>` for metrics and `omni train download` only when artifacts are requested.
+
+## Updating existing resources
+
+Use the dedicated CLI update command. The CLI follows the platform REST
+contract: algorithms, projects, and training tasks use their standard resource
+`PATCH` endpoints; only deployment configuration uses a dedicated `config`
+endpoint. Updates do not start, stop, delete, upload, rebuild, or resubmit
+anything.
+
+- Algorithm metadata: `omni algorithm update <algorithm_id> --file algorithm-update.yaml --output json`.
+  Only `name`, `description`, `type`, and `params` are editable. Use
+  `omni algorithm upload --algorithm-id` when source code changes.
+- Project metadata: `omni project update <project_id> --file project-update.yaml --output json`.
+  Only `name` and `description` are editable; project type is immutable.
+- Training configuration: `omni train update <run_id> --file train.yaml --output json`.
+  The task must still be `new`. Keep `project.train_id` and `run.type`
+  unchanged. The selected algorithm is read again so omitted base/custom
+  parameters use that algorithm's defaults. When `dataset` or `configuration`
+  is supplied, it replaces that entire nested section.
+- Deployment configuration: `omni deploy update <deploy_id> --file deploy.yaml --output json`.
+  The deployment must still be `new`. The CLI and server revalidate the
+  completed model, ONNX artifact, chip, system, framework, and quantization.
+  Deployment format remains ONNX.
+
+Always inspect the JSON returned after an update. The CLI re-fetches the
+resource so the response reflects server-authoritative values. If a training
+task or deployment has started, create a new one instead of trying to mutate
+runtime state.
+
+`omni train submit --file train.yaml --output json` remains a
+backward-compatible shortcut that creates and immediately starts a task. Use
+the explicit create-then-submit flow when the task must be inspected before
+starting.
+
+During `omni train create` and the compatible file-based submit shortcut, the
+CLI fetches the selected algorithm, fills omitted base and custom values from
+its defaults, applies the values in `train.yaml` as overrides, and validates
+types, choices, and ranges. The supported image algorithm stages are
+`dataset_preprocess`, `train`, `val`, `dataset_postprocess`, and
+`convert_onnx`. `omni train validate` is offline and checks only the file
+structure; create-time validation is authoritative for the selected algorithm.
+
+## Completed model deployment
+
+When the user asks to convert, package, or deploy a completed training model,
+**MUST read** `references/deployment.md` completely before acting.
+
+1. Run `omni deploy platforms --output json` and select only a target returned
+   by the current Workspace.
+2. Confirm the selected model is completed with
+   `omni train get <model_id> --output json`. Never deploy an unfinished model.
+3. Create `deploy.yaml` from `assets/deploy.example.yaml`. Use only the chip,
+   framework, system, quantization, and input values supported by the selected
+   platform. Never send web-only fields such as `vendor`, `vendoor`,
+   `platform`, `compiler`, or `model_name`.
+4. By default, create and start the deployment without pausing for confirmation
+   with `omni deploy submit --file deploy.yaml --output json`. Only stop after
+   creation when the user explicitly asks for create-only, no start, a draft,
+   or inspection before starting; in that case use
+   `omni deploy create --file deploy.yaml --output json`.
+5. Query `omni deploy status <deploy_id> --output json` and
+   `omni deploy logs <deploy_id> --output json`. Use
+   `omni deploy wait <deploy_id> --output json` only when the user asks to wait,
+   and never poll indefinitely.
+6. Download the completed package only when requested. When the deployment SDK
+   is requested, use
+   `omni deploy sdk <deploy_id> --output-path ./artifacts/omni-sdk.zip --output json`.
+   The deployment's stored `system` and `platform` are authoritative: never
+   invent or send target overrides for SDK download.
+7. Stop or delete a deployment only after an explicit user request. Preserve
+   failed and stopped records and their logs by default.
+
+## Custom image algorithm development
+
+When asked to generate, modify, validate, package, or troubleshoot a local
+custom image algorithm, **MUST read**
+`references/custom-image-algorithms.md` completely before acting. Treat that
+reference as the authoritative contract for entrypoints, configuration,
+LabelMe data, stage inputs and outputs, metrics, ONNX artifacts, local
+verification, packaging, and troubleshooting. Do not invent paths or rebuild
+platform-managed configuration fields.
+
+When generating a new image algorithm, follow the advisory per-epoch logging
+pattern in `references/custom-image-algorithms.md`. Skill-generated image
+algorithms should emit one progress record after every completed epoch to both
+standard output and `config["log_path"]`. This is not an upload requirement:
+do not reject, rewrite, or diagnose an independently developed algorithm only
+because its logs use another format.
+
+For Skill-generated algorithms, apply the headless image dependencies rules in
+the reference. Never generate GUI-enabled OpenCV or Ultralytics requirements
+for the platform training container.
+
+For every Skill-generated custom image algorithm, generate a separate
+`algorithm.params.yaml` from `assets/algorithm.params.example.yaml`. Its
+`params.base` configuration must declare `epochs`, `batch_size`, and
+`input_size`. Recommend at least one `params.train` custom group using only
+values the generated training code actually reads, normally including `lr`
+and `optimizer`. Adjust ranges and defaults to the real algorithm instead of
+copying the example mechanically.
+
+Pass the file explicitly during upload with
+`--params-file algorithm.params.yaml`. The CLI does not auto-discover parameter
+metadata in the ZIP or working directory. A user-supplied algorithm may still
+be uploaded without a parameter file; explain that its corresponding training
+controls will not be declared until parameter metadata is added.
+
+Before uploading or rebuilding an algorithm, **MUST also read**
+`references/cli-commands.md` and use the documented `omni algorithm upload`
+arguments. Run `omni algorithm upload --help` if the installed CLI may differ
+from the bundled reference. Use `omni algorithm base-images --output json` to
+inspect the platform-supported images. Never guess an algorithm ID or base
+image value. When `--base-image` is omitted, the CLI uses the single image
+marked as the platform default.
+
+After local verification succeeds, use `omni algorithm upload`. The command
+validates the ZIP archive locally, creates the algorithm when `--algorithm-id`
+is not supplied, uploads the archive, and submits the platform build workflow.
+The archive must have one top-level directory containing
+`dataset_preprocess.py`, `train.py`, `val.py`, `dataset_postprocess.py`,
+`convert_onnx.py`, and `requirements.txt` directly under that directory.
+Retain the returned algorithm and build IDs. Diagnose the build with
+`omni algorithm build-status <algorithm_id> <build_id>` and
+`omni algorithm build-logs <algorithm_id> <build_id>`. Use
+`omni algorithm builds <algorithm_id>` when the build ID must be discovered.
+
+Never print or request an API Key in chat, call arbitrary REST URLs, access Django models, or parse human-readable CLI output.

omni_train_cli-0.1.29/src/omni_cli/bundled_skills/omni-train/assets/algorithm.params.example.yaml

@@ -0,0 +1,60 @@
+# Parameter metadata uploaded with:
+# omni algorithm upload ... --params-file algorithm.params.yaml
+# Adjust ranges and defaults to match the algorithm implementation.
+
+base:
+  epochs:
+    key: epochs
+    name: Epochs
+    choice_type: range
+    choice_value: [1, 200]
+    value_type: int
+    default: 100
+    step: 1
+    tips: Number of completed training epochs.
+
+  batch_size:
+    key: batch_size
+    name: Batch size
+    choice_type: range
+    choice_value: [1, 512]
+    value_type: int
+    default: 16
+    step: 1
+    tips: Number of samples processed in one training batch.
+
+  input_size:
+    key: input_size
+    name: Input size
+    choice_type: s_range
+    choice_value: [32, 2048]
+    value_type: int
+    default: [224, 224]
+    step: 1
+    tips: Model input size in [width, height] order.
+
+train:
+  learning-rate:
+    key: lr
+    name: Learning rate
+    choice_type: range
+    choice_value: [0.000001, 1.0]
+    value_type: float
+    default: 0.001
+    step: 0.000001
+    tips: Initial optimizer learning rate.
+
+  optimizer:
+    key: optimizer
+    name: Optimizer
+    choice_type: choice
+    choice_value:
+      - label: SGD
+        value: SGD
+      - label: Adam
+        value: Adam
+      - label: AdamW
+        value: AdamW
+    value_type: string
+    default: AdamW
+    tips: Optimizer used by the train stage.

omni_train_cli-0.1.29/src/omni_cli/bundled_skills/omni-train/assets/deploy.example.yaml

@@ -0,0 +1,18 @@
+schema_version: 1
+name: resnet18-qcs6490-int16
+model_id: 53
+format: ONNX
+chip: QCS6490/QCM6490
+system: Android
+framework: Qualcomm
+quantized: true
+configuration:
+  weight_type: int16
+  use_weight_per_channel: true
+  inputs:
+    - name: input
+      type: image
+      data_size: [224, 224]
+      mean: [0.485, 0.456, 0.406]
+      std: [0.229, 0.224, 0.225]
+      built_in_dataset: coco

omni_train_cli-0.1.29/src/omni_cli/bundled_skills/omni-train/assets/train.example.yaml

@@ -0,0 +1,31 @@
+schema_version: 1
+project:
+  name: vehicle-detection
+  type: image
+run:
+  name: baseline
+  type: detection
+  algorithm_id: 18
+dataset:
+  dataset_id: [25, 30]
+  label: [cat, dog]
+  splits:
+    - task_id: 69
+      mode: independent
+      train: 1
+      val: 0
+    - task_id: 68
+      mode: independent
+      train: 0
+      val: 1
+configuration:
+  # Optional overrides. Omit them to use the selected algorithm's defaults.
+  # epochs: 1
+  # batch_size: 1
+  # input_size: [224, 224]
+  # Use only stages and keys declared by `omni algorithm get 18`.
+  # Omitted declared values are filled from that algorithm's defaults on submit.
+  advanced_conf:
+    train:
+      lr: 0.1786
+      optimizer: SGD