From bc63a040ae2c4d156b0a9dbdf1f8d515b1888c6b Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Fri, 18 Oct 2024 18:46:35 +0100 Subject: [PATCH] Add new types for analytical models Signed-off-by: Mandy Chessell --- .../unity-catalog/unity-catalog.drawio | 586 +++++++++++++----- site/docs/types/2/0265-Analytics-Assets.md | 18 +- site/docs/types/2/0265-Analytics-Assets.svg | 3 +- site/docs/types/2/area-2-assets.drawio | 59 +- .../parameters/external-source-ids.md | 2 +- 5 files changed, 478 insertions(+), 190 deletions(-) diff --git a/site/docs/connectors/unity-catalog/unity-catalog.drawio b/site/docs/connectors/unity-catalog/unity-catalog.drawio index 38a7496997..fdc64f88e4 100644 --- a/site/docs/connectors/unity-catalog/unity-catalog.drawio +++ b/site/docs/connectors/unity-catalog/unity-catalog.drawio @@ -1,6 +1,6 @@ - + - + @@ -16,33 +16,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -62,16 +35,16 @@ - + - + - + - + @@ -155,10 +128,7 @@ - - - - + @@ -166,11 +136,59 @@ + + + + + + + + + + + + - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -189,16 +207,13 @@ - - - - + - + @@ -217,10 +232,10 @@ - + - + @@ -290,7 +305,7 @@ - + @@ -303,25 +318,16 @@ - - - - + - + - - - - - - @@ -344,10 +350,10 @@ - + - + @@ -393,7 +399,7 @@ - + @@ -402,7 +408,7 @@ - + @@ -435,18 +441,117 @@ - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1020,7 +1125,7 @@ - + @@ -1042,31 +1147,34 @@ - + - + - + - + - + - + + + + - + - + @@ -1079,16 +1187,16 @@ - - + + - - + + - + @@ -1234,7 +1342,7 @@ - + @@ -1258,7 +1366,7 @@ - + @@ -1267,69 +1375,36 @@ - + - + - + - - + + - - - - - - - - - - - - - - - - - + + - - - - - + + - - - - - - - - - - - - - - - - - + + @@ -1388,7 +1463,7 @@ - + @@ -1404,7 +1479,7 @@ - + @@ -1417,7 +1492,7 @@ - + @@ -1426,7 +1501,7 @@ - + @@ -1488,7 +1563,7 @@ - + @@ -1501,7 +1576,7 @@ - + @@ -1514,13 +1589,16 @@ + + + - + @@ -1528,11 +1606,11 @@ - + - + @@ -1548,16 +1626,16 @@ - - + + - - + + - + @@ -1595,7 +1673,7 @@ - + @@ -1604,13 +1682,13 @@ - + - + @@ -1622,48 +1700,54 @@ - + - + - - + + - + - + - - + + - + + + + + + + - - + + - - + + - + - + @@ -1675,7 +1759,7 @@ - + @@ -1684,7 +1768,7 @@ - + @@ -1692,28 +1776,198 @@ - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/types/2/0265-Analytics-Assets.md b/site/docs/types/2/0265-Analytics-Assets.md index 730622dbcf..05c32f4b21 100644 --- a/site/docs/types/2/0265-Analytics-Assets.md +++ b/site/docs/types/2/0265-Analytics-Assets.md @@ -1,16 +1,20 @@ ---- -hide: -- toc ---- - # 0265 Analytics Assets -This classification enables analytical -components to be identified in lineage. +The term *Analytics* is use here to describe processing that is trained and operated using data. [Analytical Development Assets](/types/2/0285-Analytical-Development-Assets) cover the training process. The assets below describe the deployed and running components. ![UML](0265-Analytics-Assets.svg) +## DeployedAnalyticsModel entity + +The *DeployedAnalyticsModel* entity describes an Analytics Model that is deployed into one or more IT infrastructure environments. It is a type of [DeployedSoftwareComponent](/types/2/0215-Software-Components). + +## AnalyticsModelRun entity + +The *AnalyticsModelRun* entity describes an invocation of a deployed Analytics Model. It is a type of [TransientEmbeddedProcess](/types/2/0215-Software-Components). + +An *AnalyticsModelRun* entity is typically linked to its *DeployedAnalyticsModel* entity using the [ProcessHierarchy](/types/2/0215-Software-Components) relationship. + --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/types/2/0265-Analytics-Assets.svg b/site/docs/types/2/0265-Analytics-Assets.svg index 3ae6c1d22c..57cd5327ff 100644 --- a/site/docs/types/2/0265-Analytics-Assets.svg +++ b/site/docs/types/2/0265-Analytics-Assets.svg @@ -1,3 +1,4 @@ + -
0265 - Analytics Assets
0265 - Analytics Assets
«classification»
DeployedAnalyticalComponent
«classification»...
«entity»
Process
«entity»...Viewer does not support full SVG 1.1 \ No newline at end of file +
0265 - Analytics Assets
*
«entity»
DeployedSoftwareComponent
«entity»
DeployedAnalyticsModel
«entity»
TransientEmbeddedProcess
«entity»
AnalyticsModelRun
 \ No newline at end of file diff --git a/site/docs/types/2/area-2-assets.drawio b/site/docs/types/2/area-2-assets.drawio index 6f39d38962..f35fd5628e 100644 --- a/site/docs/types/2/area-2-assets.drawio +++ b/site/docs/types/2/area-2-assets.drawio @@ -1,4 +1,4 @@ - + @@ -1938,7 +1938,7 @@ - + @@ -1948,23 +1948,52 @@ - - + + - - - - + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + - - + + - - + + + + + + + + @@ -2309,7 +2338,7 @@ - + diff --git a/site/snippets/parameters/external-source-ids.md b/site/snippets/parameters/external-source-ids.md index 6dc4cb025a..415924b4b3 100644 --- a/site/snippets/parameters/external-source-ids.md +++ b/site/snippets/parameters/external-source-ids.md @@ -1,7 +1,7 @@ -The external source identifiers, `externalSourceGUID` and `externalSourceName` are used to set up an [external metadata collection](/concepts/metadata-collection) for new metadata elements. Update and delete requests use the same identifiers to indicate they belong to the same "system" and have rights to chang it. +The external source identifiers, `externalSourceGUID` and `externalSourceName` are used to set up an [external metadata collection](/concepts/metadata-collection) for new metadata elements. Update and delete requests use the same identifiers to indicate they belong to the same "system" and have rights to change it.