acryl-datahub-cloud 0.3.7.9rc1__py3-none-any.whl → 0.3.8__py3-none-any.whl

acryl_datahub_cloud/metadata/schemas/MLModelProperties.avsc

@@ -37,6 +37,66 @@
       "default": null,
       "doc": "URL where the reference exist"
     },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "dataJob",
+            "dataProcessInstance"
+          ],
+          "isLineage": true,
+          "name": "TrainedBy"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "trainingJobs",
+      "default": null,
+      "doc": "List of jobs or process instances (if any) used to train the model or group. Visible in Lineage. Note that ML Models can also be specified as the output of a specific Data Process Instances (runs) via the DataProcessInstanceOutputs aspect."
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "dataJob",
+            "dataProcessInstance"
+          ],
+          "isLineage": true,
+          "isUpstream": false,
+          "name": "UsedBy"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "downstreamJobs",
+      "default": null,
+      "doc": "List of jobs or process instances (if any) that use the model or group."
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldType": "WORD_GRAM",
+        "queryByDefault": true
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "name",
+      "default": null,
+      "doc": "Display name of the MLModel"
+    },
     {
       "Searchable": {
         "fieldType": "TEXT",
@@ -51,6 +111,7 @@
       "doc": "Documentation of the MLModel"
     },
     {
+      "deprecated": true,
       "type": [
         "null",
         "long"
@@ -59,6 +120,49 @@
       "default": null,
       "doc": "Date when the MLModel was developed"
     },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "TimeStamp",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "type": "long",
+              "name": "time",
+              "doc": "When did the event occur"
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "actor",
+              "default": null,
+              "doc": "Optional: The actor urn involved in the event.",
+              "Urn": "Urn"
+            }
+          ],
+          "doc": "A standard event timestamp"
+        }
+      ],
+      "name": "created",
+      "default": null,
+      "doc": "Audit stamp containing who created this and when"
+    },
+    {
+      "type": [
+        "null",
+        "com.linkedin.pegasus2avro.common.TimeStamp"
+      ],
+      "name": "lastModified",
+      "default": null,
+      "doc": "Date when the MLModel was last modified"
+    },
     {
       "type": [
         "null",
@@ -74,6 +178,57 @@
               ],
               "name": "versionTag",
               "default": null
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "MetadataAttribution",
+                  "namespace": "com.linkedin.pegasus2avro.common",
+                  "fields": [
+                    {
+                      "type": "long",
+                      "name": "time",
+                      "doc": "When this metadata was updated."
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": "string",
+                      "name": "actor",
+                      "doc": "The entity (e.g. a member URN) responsible for applying the assocated metadata. This can\neither be a user (in case of UI edits) or the datahub system for automation.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "source",
+                      "default": null,
+                      "doc": "The DataHub source responsible for applying the associated metadata. This will only be filled out\nwhen a DataHub source is responsible. This includes the specific metadata test urn, the automation urn.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "type": {
+                        "type": "map",
+                        "values": "string"
+                      },
+                      "name": "sourceDetail",
+                      "default": {},
+                      "doc": "The details associated with why this metadata was applied. For example, this could include\nthe actual regex rule, sql statement, ingestion pipeline ID, etc.\nAlso can include flags like 'propagated'=true or 'inferred'=true."
+                    }
+                  ],
+                  "doc": "Information about who, why, and how this metadata was applied"
+                }
+              ],
+              "name": "metadataAttribution",
+              "default": null
             }
           ],
           "doc": "A resource-defined string representing the resource state for the purpose of concurrency control"
@@ -287,53 +442,6 @@
       "Urn": "Urn",
       "urn_is_array": true
     },
-    {
-      "Relationship": {
-        "/*": {
-          "entityTypes": [
-            "dataJob"
-          ],
-          "isLineage": true,
-          "name": "TrainedBy"
-        }
-      },
-      "type": [
-        "null",
-        {
-          "type": "array",
-          "items": "string"
-        }
-      ],
-      "name": "trainingJobs",
-      "default": null,
-      "doc": "List of jobs (if any) used to train the model",
-      "Urn": "Urn",
-      "urn_is_array": true
-    },
-    {
-      "Relationship": {
-        "/*": {
-          "entityTypes": [
-            "dataJob"
-          ],
-          "isLineage": true,
-          "isUpstream": false,
-          "name": "UsedBy"
-        }
-      },
-      "type": [
-        "null",
-        {
-          "type": "array",
-          "items": "string"
-        }
-      ],
-      "name": "downstreamJobs",
-      "default": null,
-      "doc": "List of jobs (if any) that use the model",
-      "Urn": "Urn",
-      "urn_is_array": true
-    },
     {
       "Relationship": {
         "/*": {

acryl_datahub_cloud/metadata/schemas/MLPrimaryKeyProperties.avsc

@@ -101,6 +101,57 @@
               ],
               "name": "versionTag",
               "default": null
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "MetadataAttribution",
+                  "namespace": "com.linkedin.pegasus2avro.common",
+                  "fields": [
+                    {
+                      "type": "long",
+                      "name": "time",
+                      "doc": "When this metadata was updated."
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": "string",
+                      "name": "actor",
+                      "doc": "The entity (e.g. a member URN) responsible for applying the assocated metadata. This can\neither be a user (in case of UI edits) or the datahub system for automation.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "source",
+                      "default": null,
+                      "doc": "The DataHub source responsible for applying the associated metadata. This will only be filled out\nwhen a DataHub source is responsible. This includes the specific metadata test urn, the automation urn.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "type": {
+                        "type": "map",
+                        "values": "string"
+                      },
+                      "name": "sourceDetail",
+                      "default": {},
+                      "doc": "The details associated with why this metadata was applied. For example, this could include\nthe actual regex rule, sql statement, ingestion pipeline ID, etc.\nAlso can include flags like 'propagated'=true or 'inferred'=true."
+                    }
+                  ],
+                  "doc": "Information about who, why, and how this metadata was applied"
+                }
+              ],
+              "name": "metadataAttribution",
+              "default": null
             }
           ],
           "doc": "A resource-defined string representing the resource state for the purpose of concurrency control"

acryl_datahub_cloud/metadata/schemas/MLTrainingRunProperties.avsc

@@ -0,0 +1,171 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlTrainingRunProperties"
+  },
+  "name": "MLTrainingRunProperties",
+  "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.url.Url",
+        "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "externalUrl",
+      "default": null,
+      "doc": "URL where the reference exist"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "id",
+      "default": null,
+      "doc": "Run Id of the ML Training Run"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "outputUrls",
+      "default": null,
+      "doc": "List of URLs for the Outputs of the ML Training Run"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": {
+            "type": "record",
+            "Aspect": {
+              "name": "mlHyperParam"
+            },
+            "name": "MLHyperParam",
+            "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+            "fields": [
+              {
+                "type": "string",
+                "name": "name",
+                "doc": "Name of the MLHyperParam"
+              },
+              {
+                "type": [
+                  "null",
+                  "string"
+                ],
+                "name": "description",
+                "default": null,
+                "doc": "Documentation of the MLHyperParam"
+              },
+              {
+                "type": [
+                  "null",
+                  "string"
+                ],
+                "name": "value",
+                "default": null,
+                "doc": "The value of the MLHyperParam"
+              },
+              {
+                "type": [
+                  "null",
+                  "long"
+                ],
+                "name": "createdAt",
+                "default": null,
+                "doc": "Date when the MLHyperParam was developed"
+              }
+            ],
+            "doc": "Properties associated with an ML Hyper Param"
+          }
+        }
+      ],
+      "name": "hyperParams",
+      "default": null,
+      "doc": "Hyperparameters of the ML Training Run"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": {
+            "type": "record",
+            "Aspect": {
+              "name": "mlMetric"
+            },
+            "name": "MLMetric",
+            "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+            "fields": [
+              {
+                "type": "string",
+                "name": "name",
+                "doc": "Name of the mlMetric"
+              },
+              {
+                "type": [
+                  "null",
+                  "string"
+                ],
+                "name": "description",
+                "default": null,
+                "doc": "Documentation of the mlMetric"
+              },
+              {
+                "type": [
+                  "null",
+                  "string"
+                ],
+                "name": "value",
+                "default": null,
+                "doc": "The value of the mlMetric"
+              },
+              {
+                "type": [
+                  "null",
+                  "long"
+                ],
+                "name": "createdAt",
+                "default": null,
+                "doc": "Date when the mlMetric was developed"
+              }
+            ],
+            "doc": "Properties associated with an ML Metric"
+          }
+        }
+      ],
+      "name": "trainingMetrics",
+      "default": null,
+      "doc": "Metrics of the ML Training Run"
+    }
+  ],
+  "doc": "The inputs and outputs of this training run"
+}