metamodel updates (#54)

* metamode updates

Added model name to type and updated docs

Signed-off-by: Prasad Mujumdar <[email protected]>

* Updates per review feedback

Signed-off-by: Prasad Mujumdar <[email protected]>

---------

Signed-off-by: Prasad Mujumdar <[email protected]>

src/monocle_apptrace/metamodel/entities/README.md

@@ -1,33 +1,44 @@
 # Monocle Entities
 The entity type defines the type of GenAI component that Monocle understand. The monocle instrumentation can extract the relevenat information for this entity. There are a fixed set of [entity types](./entity_types.py) that are defined by Monocle out of the box, eg workflow, model etc. As the GenAI landscape evolves, the Monocle community will introduce a new entity type if the current entities won't represent a new technology component.
 
-## Entity Types
+## Entities
 Following attributes are supported for all entities
 | Name | Description | Required |
 | - | - | - |
 | name | Entity name generated by Monocle | Required |
-| type | Monocle Entity type | True |
+| type | entity.category.type | True |
 
 ### MonocleEntity.Workflow
-Workflow ie the core application code. Supported types are -
+Workflow ie the core application code. 
+#### Workflow types
 - generic
 - langchain
-- llama_index
+- llamaindex
 - haystack
 
 ### MonocleEntity.Model
-GenAI models. Supported types are -
+GenAI models. It has following sub categories
 - generic
 - llm
 - embedding
+#### Model types
+- gpt3
+- gpt-3.5
+- gpt-3.5-turbo
+- gpt4
+- gpt4o
+- gpt4o-mini
+- ollama
+
 Following attributes are supported for all model type entities
 | Name | Description | Required |
 | - | - | - |
-| model_name | Name of model | True |
-
+| parameters | model parameters | false |
+| algorithm | model algorithm | false |
 
 ### MonocleEntity.AppHosting
-Application host services where the workflow code is run. Supported types are -
+Application host services where the workflow code is run.
+#### AppHosting types
 - generic
 - aws_lambda
 - aws_sagemaker
@@ -36,7 +47,12 @@ Application host services where the workflow code is run. Supported types are -
 - azure_mlw
 
 ### MonocleEntity.Inference
-The model hosting infrastructure services. Supported types are -
+The model hosting infrastructure services.
+Following attributes are supported for inference type entities
+| Name | Description | Required |
+| - | - | - |
+| inference_endpoint | connection endpoint for inference service | false |
+#### Inference types
 - generic
 - nvidia_triton
 - openai
@@ -45,8 +61,15 @@ The model hosting infrastructure services. Supported types are -
 - aws_bedrock
 - hugging_face
 
+Following attributes are supported for inference type entities
+| Name | Description | Inference type | Required |
+| - | - | - | - |
+| deployment | model deployment name | azure_oai | false |
+
+
 ### MonocleEntity.VectorStore
-Vector search data stores. Supported types are -
+Vector search data stores.
+#### VectorStore types
 - generic
 - chroma
 - aws_es

src/monocle_apptrace/metamodel/entities/app_hosting_types.json

@@ -0,0 +1,29 @@
+{
+    "entity" : "app_hosting",
+    "types": [
+        {
+            "name": "aws_lambda",
+            "attributes" : []
+        },
+        {
+            "name": "aws_sagemaker",
+            "attributes" : []
+        },
+        {
+            "name": "azure_func",
+            "attributes" : []
+        },
+        {
+            "name": "azure_mlw",
+            "attributes" : []
+        },
+        {
+            "name": "github_codespace",
+            "attributes" : []
+        },
+        {
+            "name": "generic",
+            "attributes" : []
+        }
+    ]
+}

src/monocle_apptrace/metamodel/entities/entities.json

@@ -0,0 +1,49 @@
+{
+    "description": "Monocle entities represents kinds GenAI technology components and their implementations supported by Monocle",
+    "monocle_entities": [
+        {
+            "name": "workflow",
+            "attributes" : [],
+            "categories": []
+        },
+        {
+            "name": "model",
+            "attributes" : [
+                {
+                    "attribute_name": "model_name",
+                    "attribute_description": "Model name",
+                    "required": true
+                }
+            ],
+            "categories": [
+                {
+                    "name": "llm",
+                    "attributes" : []
+                },
+                {
+                    "name": "embedding",
+                    "attributes" : []
+                },
+                {
+                    "name": "generic",
+                    "attributes" : []
+                }
+            ]
+        },
+        {
+            "name": "vector_store",
+            "attributes" : [],
+            "categories": []
+        },
+        {
+            "name": "app_hosting",
+            "attributes" : [],
+            "categories": []
+        },
+        {
+            "name": "inference",
+            "attributes" : [],
+            "categories": []
+        }
+    ]
+}