Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

metamodel updates #54

Merged
merged 2 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 33 additions & 10 deletions src/monocle_apptrace/metamodel/entities/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
29 changes: 29 additions & 0 deletions src/monocle_apptrace/metamodel/entities/app_hosting_types.json
Original file line number Diff line number Diff line change
@@ -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" : []
}
]
}
49 changes: 49 additions & 0 deletions src/monocle_apptrace/metamodel/entities/entities.json
Original file line number Diff line number Diff line change
@@ -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": []
}
]
}
157 changes: 0 additions & 157 deletions src/monocle_apptrace/metamodel/entities/entity_types.json

This file was deleted.

51 changes: 0 additions & 51 deletions src/monocle_apptrace/metamodel/entities/entity_types.py

This file was deleted.

Loading
Loading