Skip to content

[docs] specification of custom model#272

Open
mirkoCrobu wants to merge 8 commits intomainfrom
custom_model_specification
Open

[docs] specification of custom model#272
mirkoCrobu wants to merge 8 commits intomainfrom
custom_model_specification

Conversation

@mirkoCrobu
Copy link
Copy Markdown
Contributor

@mirkoCrobu mirkoCrobu commented Feb 25, 2026

Motivation

Create a model specification (like the app specification) for the custom model

Change description

add custom model specification file

Additional Notes

Reviewer checklist

  • PR addresses a single concern.
  • PR title and description are properly filled.
  • Changes will be merged in main.
  • Changes are covered by tests.
  • Logging is meaningful in case of troubleshooting.

@mirkoCrobu mirkoCrobu requested a review from dido18 February 25, 2026 14:33
@mirkoCrobu mirkoCrobu self-assigned this Feb 25, 2026
@mirkoCrobu mirkoCrobu requested a review from a team February 25, 2026 14:33
@mirkoCrobu mirkoCrobu added the documentation Improvements or additions to documentation label Feb 25, 2026
@mirkoCrobu mirkoCrobu force-pushed the custom_model_specification branch 2 times, most recently from bb3671e to bafb1da Compare March 9, 2026 15:02
@mirkoCrobu mirkoCrobu changed the title [docs] Validation + specification of custom model [docs] specification of custom model Mar 9, 2026
@mirkoCrobu mirkoCrobu requested review from Xayton and dido18 March 9, 2026 15:15
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 18, 2026

CLA assistant check
All committers have signed the CLA.


### 1.2 Model-AI Brick Relationship and Compatibility

The ecosystem implements a flexible N:N (Many-to-Many) relationship between Bricks and Models:
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.

Why we say that a AI Brick manages a specific AI domain, if we can have a N:N relationship and even swap between models that should be relagated to one Domain.
E.I. How is possible that Object detection can be used by Face Detection?
Is this restriction on AI domain just a definition but not an hard contraint in the real application?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

it is a bit confusing. Do you think it is clearer the following:

Model Versatility: A single AI Model can be compatible with multiple Bricks. Compatibility is determined by the model's category. For example, a model belonging to the "Object Detection" category is automatically compatible with both arduino:object_detection and arduino:video_object_detection bricks.

@giulio93
Copy link
Copy Markdown
Contributor

I think the document is not general enough, everything seams to be tight around the EI model structure, we might need another iteration

Copy link
Copy Markdown
Contributor

@dido18 dido18 left a comment

Choose a reason for hiding this comment

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

I would make the following changes:

  • Remove the numbers in the titles/subtitles.
  • start with the "AI Arduino specification"
  • make the AI brick discussion a "note" of the document.

@mirkoCrobu mirkoCrobu force-pushed the custom_model_specification branch from 0f97322 to 074a307 Compare April 7, 2026 13:37
@mirkoCrobu mirkoCrobu requested a review from a team April 8, 2026 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants