Skip to content

docs: Deprecate ONNX legacy config and modernize Vision ML for INFERENCE#79

Open
javoweb-fc wants to merge 3 commits into
v2from
task/FLCRM-20635-onnx-litert-deprecation
Open

docs: Deprecate ONNX legacy config and modernize Vision ML for INFERENCE#79
javoweb-fc wants to merge 3 commits into
v2from
task/FLCRM-20635-onnx-litert-deprecation

Conversation

@javoweb-fc

@javoweb-fc javoweb-fc commented Jul 9, 2026

Copy link
Copy Markdown

Description

This PR updates the developer reference documentation for the INFERENCE data event function to align with the latest on-device Vision ML runtime capabilities and contracts, while keeping underlying backend engines transparent to developers.

Key Changes

  1. User-Friendly Abstraction: Removed direct references to underlying engine internals in user-facing text.
  2. Strict File-Extension-Based Auto-Detection: Documented that model type auto-detection is determined strictly by the file extension (.tflite for Vision ML). Clarified that config-level parameters do not affect or override detection, but must still match the model type.
  3. Streamlined Model Loading (Form Reference Files Only): Removed references to the central Model Catalog, catalog IDs, and resolution priority. Documentation now focuses exclusively on loading custom models via Form Reference Files.
  4. ONNX Support Deprecation: Marked the legacy/ONNX-based configuration as Deprecated and added guidance to update to the newer config-based model definitions.
  5. Execution Modes: Documented two paths: Vision ML and Legacy Vision ML (Deprecated).
  6. Performance and Device Warnings: Added a prominent callout warning about computational overhead, device memory footprint, and battery drain.
  7. Updated Examples: Updated the standard Vision ML example to use the modern config syntax.

JIRA / Issue Reference

Ref: FLCRM-20635

Notes

This is the first of two stacked PRs splitting the original #76. Part 2 (Generative LLM support) is stacked on top of this branch and targets it directly.

Copilot AI review requested due to automatic review settings July 9, 2026 21:19
@javoweb-fc javoweb-fc requested review from a team as code owners July 9, 2026 21:19
@javoweb-fc javoweb-fc marked this pull request as draft July 9, 2026 21:19

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.

Updates the INFERENCE data event documentation to reflect the modern on-device Vision ML runtime, deprecate the legacy ONNX-based mode, and clarify model loading/detection behavior for developers.

Changes:

  • Reframes INFERENCE as on-device Vision ML with clearer execution modes and a prominent device resource warning.
  • Documents strict file-extension-based model auto-detection and focuses model loading on form reference files.
  • Deprecates the legacy ONNX path and refreshes the primary example to the modern config syntax.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md Outdated
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md Outdated
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md Outdated
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md Outdated
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md Outdated
Copilot AI review requested due to automatic review settings July 9, 2026 21:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md Outdated
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md Outdated
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
Copilot AI review requested due to automatic review settings July 9, 2026 22:14
@javoweb-fc javoweb-fc marked this pull request as ready for review July 9, 2026 22:17

@HenryTabima HenryTabima left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 8 comments.

Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
Comment thread docs/DATA EVENTS/data-events-reference/data-events-inference.md
@javoweb-fc javoweb-fc self-assigned this Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants