add lite model information to brickDetails endpoint

Author: mirkoCrobu

internal/api/docs/openapi.yaml

@@ -1171,6 +1171,8 @@ components:
         runner:
           type: string
       type: object
+    AIModelLite:
+      type: object
     AIModelsListResult:
       properties:
         models:
@@ -1314,6 +1316,11 @@ components:
           type: string
         id:
           type: string
+        models:
+          items:
+            $ref: '#/components/schemas/AIModelLite'
+          nullable: true
+          type: array
         name:
           type: string
         readme:

internal/e2e/client/client.gen.go

@@ -30,6 +30,7 @@ import (
 	"github.com/arduino/arduino-app-cli/internal/e2e/client"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/bricksindex"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/modelsindex"
 	"github.com/arduino/arduino-app-cli/internal/store"
 )
 
@@ -115,6 +116,17 @@ func TestBricksDetails(t *testing.T) {
 			},
 		}
 
+		expectedModelLiteInfo := []modelsindex.AIModelLite{
+			{
+				ID:                "mobilenet-image-classification",
+				Name:              "General purpose image classification",
+				ModuleDescription: "General purpose image classification model based on MobileNetV2. This model is trained on the ImageNet dataset and can classify images into 1000 categories.",
+			},
+			{
+				ID:                "person-classification",
+				Name:              "Person classification",
+				ModuleDescription: "Person classification model based on WakeVision dataset. This model is trained to classify images into two categories: person and not-person.",
+			}}
 		response, err := httpClient.GetBrickDetailsWithResponse(t.Context(), validBrickID, func(ctx context.Context, req *http.Request) error { return nil })
 		require.NoError(t, err)
 		require.Equal(t, http.StatusOK, response.StatusCode(), "status code should be 200 ok")
@@ -133,5 +145,7 @@ func TestBricksDetails(t *testing.T) {
 		require.NotEmpty(t, *response.JSON200.Readme)
 		require.NotNil(t, response.JSON200.UsedByApps, "UsedByApps should not be nil")
 		require.Equal(t, expectedUsedByApps, *(response.JSON200.UsedByApps))
+		require.NotNil(t, response.JSON200.Models, "Models should not be nil")
+		require.Equal(t, expectedModelLiteInfo, *(response.JSON200.Models))
 	})
 }

internal/e2e/daemon/brick_test.go

@@ -190,7 +190,6 @@ func (s *Service) BricksDetails(id string, idProvider *app.IDProvider,
 	if err != nil {
 		return BrickDetailsResult{}, fmt.Errorf("unable to get used by apps: %w", err)
 	}
-
 	return BrickDetailsResult{
 		ID:           id,
 		Name:         brick.Name,
@@ -203,6 +202,7 @@ func (s *Service) BricksDetails(id string, idProvider *app.IDProvider,
 		ApiDocsPath:  apiDocsPath,
 		CodeExamples: codeExamples,
 		UsedByApps:   usedByApps,
+		Models:       s.modelsIndex.GetModelsLiteInfoByBrick(brick.ID),
 	}, nil
 }
 

internal/orchestrator/bricks/bricks.go

@@ -15,6 +15,8 @@
 
 package bricks
 
+import "github.com/arduino/arduino-app-cli/internal/orchestrator/modelsindex"
+
 type BrickListResult struct {
 	Bricks []BrickListItem `json:"bricks"`
 }
@@ -66,15 +68,16 @@ type AppReference struct {
 }
 
 type BrickDetailsResult struct {
-	ID           string                   `json:"id"`
-	Name         string                   `json:"name"`
-	Author       string                   `json:"author"`
-	Description  string                   `json:"description"`
-	Category     string                   `json:"category"`
-	Status       string                   `json:"status"`
-	Variables    map[string]BrickVariable `json:"variables,omitempty"`
-	Readme       string                   `json:"readme"`
-	ApiDocsPath  string                   `json:"api_docs_path"`
-	CodeExamples []CodeExample            `json:"code_examples"`
-	UsedByApps   []AppReference           `json:"used_by_apps"`
+	ID           string                    `json:"id"`
+	Name         string                    `json:"name"`
+	Author       string                    `json:"author"`
+	Description  string                    `json:"description"`
+	Category     string                    `json:"category"`
+	Status       string                    `json:"status"`
+	Variables    map[string]BrickVariable  `json:"variables,omitempty"`
+	Readme       string                    `json:"readme"`
+	ApiDocsPath  string                    `json:"api_docs_path"`
+	CodeExamples []CodeExample             `json:"code_examples"`
+	UsedByApps   []AppReference            `json:"used_by_apps"`
+	Models       []modelsindex.AIModelLite `json:"models"`
 }

internal/orchestrator/bricks/types.go

@@ -53,6 +53,12 @@ type AIModel struct {
 	ModelConfiguration map[string]string `yaml:"model_configuration,omitempty"`
 }
 
+type AIModelLite struct {
+	ID                string `yaml:"-"`
+	Name              string `yaml:"name"`
+	ModuleDescription string `yaml:"description"`
+}
+
 type ModelsIndex struct {
 	models []AIModel
 }
@@ -82,6 +88,25 @@ func (m *ModelsIndex) GetModelsByBrick(brick string) []AIModel {
 	return matches
 }
 
+func (m *ModelsIndex) GetModelsLiteInfoByBrick(brick string) []AIModelLite {
+	var matches []AIModelLite
+	for i := range m.models {
+		if len(m.models[i].Bricks) > 0 && slices.Contains(m.models[i].Bricks, brick) {
+			matches = append(matches,
+				AIModelLite{
+					ID:                m.models[i].ID,
+					Name:              m.models[i].Name,
+					ModuleDescription: m.models[i].ModuleDescription,
+				},
+			)
+		}
+	}
+	if len(matches) == 0 {
+		return []AIModelLite{}
+	}
+	return matches
+}
+
 func (m *ModelsIndex) GetModelsByBricks(bricks []string) []AIModel {
 	var matchingModels []AIModel
 	for _, model := range m.models {

internal/orchestrator/modelsindex/models_index.go

@@ -69,4 +69,15 @@ func TestModelsIndex(t *testing.T) {
 		assert.Equal(t, "face-detection", models[0].ID)
 		assert.Equal(t, "yolox-object-detection", models[1].ID)
 	})
+
+	t.Run("it gets models lite by a brick", func(t *testing.T) {
+		model := modelsIndex.GetModelsLiteInfoByBrick("not-existing-brick")
+		assert.Nil(t, model)
+
+		model = modelsIndex.GetModelsLiteInfoByBrick("arduino:object_detection")
+		assert.Len(t, model, 1)
+		assert.Equal(t, "face-detection", model[0].ID)
+		assert.Equal(t, "Face bounding box detection. This model is trained on the WIDER FACE dataset and can detect faces in images.", model[0].ModuleDescription)
+		assert.Equal(t, "Lightweight-Face-Detection", model[0].Name)
+	})
 }