acryl-datahub-cloud 0.3.8rc8__py3-none-any.whl → 0.3.8rc9__py3-none-any.whl

acryl_datahub_cloud/metadata/schemas/MLFeatureTableProperties.avsc

@@ -0,0 +1,95 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlFeatureTableProperties"
+  },
+  "name": "MLFeatureTableProperties",
+  "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": "TEXT",
+        "hasValuesFieldName": "hasDescription"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Documentation of the MLFeatureTable"
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "mlFeature"
+          ],
+          "name": "Contains"
+        }
+      },
+      "Searchable": {
+        "/*": {
+          "fieldName": "features",
+          "fieldType": "URN"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "mlFeatures",
+      "default": null,
+      "doc": "List of features contained in the feature table",
+      "Urn": "Urn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "mlPrimaryKey"
+          ],
+          "name": "KeyedBy"
+        }
+      },
+      "Searchable": {
+        "/*": {
+          "fieldName": "primaryKeys",
+          "fieldType": "URN"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "mlPrimaryKeys",
+      "default": null,
+      "doc": "List of primary keys in the feature table (if multiple, assumed to act as a composite key)",
+      "Urn": "Urn",
+      "urn_is_array": true
+    }
+  ],
+  "doc": "Properties associated with a MLFeatureTable"
+}

acryl_datahub_cloud/metadata/schemas/MLHyperParam.avsc

@@ -0,0 +1,43 @@
+{
+  "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"
+}

acryl_datahub_cloud/metadata/schemas/MLMetric.avsc

@@ -0,0 +1,43 @@
+{
+  "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"
+}

acryl_datahub_cloud/metadata/schemas/MLModelDeploymentKey.avsc

@@ -0,0 +1,92 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlModelDeploymentKey",
+    "keyForEntity": "mlModelDeployment",
+    "entityCategory": "core",
+    "entityAspects": [
+      "mlModelDeploymentProperties",
+      "ownership",
+      "status",
+      "deprecation",
+      "globalTags",
+      "dataPlatformInstance",
+      "testResults"
+    ]
+  },
+  "name": "MLModelDeploymentKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "platform",
+      "doc": "Standardized platform urn for the model Deployment",
+      "Urn": "Urn"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "Name of the MLModelDeployment"
+    },
+    {
+      "Searchable": {
+        "addToFilters": true,
+        "fieldType": "TEXT_PARTIAL",
+        "filterNameOverride": "Environment",
+        "queryByDefault": false
+      },
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "CORP": "Designates corporation fabrics",
+          "DEV": "Designates development fabrics",
+          "EI": "Designates early-integration fabrics",
+          "NON_PROD": "Designates non-production fabrics",
+          "PRD": "Alternative Prod spelling",
+          "PRE": "Designates pre-production fabrics",
+          "PROD": "Designates production fabrics",
+          "QA": "Designates quality assurance fabrics",
+          "RVW": "Designates review fabrics",
+          "SANDBOX": "Designates sandbox fabrics",
+          "STG": "Designates staging fabrics",
+          "TEST": "Designates testing fabrics",
+          "TST": "Alternative Test spelling",
+          "UAT": "Designates user acceptance testing fabrics"
+        },
+        "name": "FabricType",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "symbols": [
+          "DEV",
+          "TEST",
+          "QA",
+          "UAT",
+          "EI",
+          "PRE",
+          "STG",
+          "NON_PROD",
+          "PROD",
+          "CORP",
+          "RVW",
+          "PRD",
+          "TST",
+          "SANDBOX"
+        ],
+        "doc": "Fabric group type"
+      },
+      "name": "origin",
+      "doc": "Fabric type where model Deployment belongs to or where it was generated"
+    }
+  ],
+  "doc": "Key for an ML model deployment"
+}

acryl_datahub_cloud/metadata/schemas/MLModelDeploymentProperties.avsc

@@ -0,0 +1,173 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlModelDeploymentProperties"
+  },
+  "name": "MLModelDeploymentProperties",
+  "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"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT",
+        "hasValuesFieldName": "hasDescription"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Documentation of the MLModelDeployment"
+    },
+    {
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "createdAt",
+      "default": null,
+      "doc": "Date when the MLModelDeployment was developed"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "VersionTag",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "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"
+        }
+      ],
+      "name": "version",
+      "default": null,
+      "doc": "Version of the MLModelDeployment"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "enum",
+          "symbolDocs": {
+            "CREATING": "Deployments being created.",
+            "DELETING": "Deployments being deleted.",
+            "FAILED": "Deployments with an error state.",
+            "IN_SERVICE": "Deployments that are active.",
+            "OUT_OF_SERVICE": "Deployments out of service.",
+            "ROLLING_BACK": "Deployments being reverted to a previous version.",
+            "UNKNOWN": "Deployments with unknown/unmappable state.",
+            "UPDATING": "Deployments being updated."
+          },
+          "name": "DeploymentStatus",
+          "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+          "symbols": [
+            "OUT_OF_SERVICE",
+            "CREATING",
+            "UPDATING",
+            "ROLLING_BACK",
+            "IN_SERVICE",
+            "DELETING",
+            "FAILED",
+            "UNKNOWN"
+          ],
+          "doc": "Model endpoint statuses"
+        }
+      ],
+      "name": "status",
+      "default": null,
+      "doc": "Status of the deployment"
+    }
+  ],
+  "doc": "Properties associated with an ML Model Deployment"
+}

acryl_datahub_cloud/metadata/schemas/MLModelFactorPrompts.avsc

@@ -0,0 +1,78 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlModelFactorPrompts"
+  },
+  "name": "MLModelFactorPrompts",
+  "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+  "fields": [
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": {
+            "type": "record",
+            "name": "MLModelFactors",
+            "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+            "fields": [
+              {
+                "type": [
+                  "null",
+                  {
+                    "type": "array",
+                    "items": "string"
+                  }
+                ],
+                "name": "groups",
+                "default": null,
+                "doc": "Groups refers to distinct categories with similar characteristics that are present in the evaluation data instances.\nFor human-centric machine learning MLModels, groups are people who share one or multiple characteristics."
+              },
+              {
+                "type": [
+                  "null",
+                  {
+                    "type": "array",
+                    "items": "string"
+                  }
+                ],
+                "name": "instrumentation",
+                "default": null,
+                "doc": "The performance of a MLModel can vary depending on what instruments were used to capture the input to the MLModel.\nFor example, a face detection model may perform differently depending on the camera's hardware and software,\nincluding lens, image stabilization, high dynamic range techniques, and background blurring for portrait mode."
+              },
+              {
+                "type": [
+                  "null",
+                  {
+                    "type": "array",
+                    "items": "string"
+                  }
+                ],
+                "name": "environment",
+                "default": null,
+                "doc": "A further factor affecting MLModel performance is the environment in which it is deployed."
+              }
+            ],
+            "doc": "Factors affecting the performance of the MLModel."
+          }
+        }
+      ],
+      "name": "relevantFactors",
+      "default": null,
+      "doc": "What are foreseeable salient factors for which MLModel performance may vary, and how were these determined?"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "com.linkedin.pegasus2avro.ml.metadata.MLModelFactors"
+        }
+      ],
+      "name": "evaluationFactors",
+      "default": null,
+      "doc": "Which factors are being reported, and why were these chosen?"
+    }
+  ],
+  "doc": "Prompts which affect the performance of the MLModel"
+}

acryl_datahub_cloud/metadata/schemas/MLModelGroupKey.avsc

@@ -0,0 +1,102 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlModelGroupKey",
+    "keyForEntity": "mlModelGroup",
+    "entityCategory": "core",
+    "entityAspects": [
+      "glossaryTerms",
+      "editableMlModelGroupProperties",
+      "domains",
+      "proposals",
+      "mlModelGroupProperties",
+      "ownership",
+      "status",
+      "deprecation",
+      "browsePaths",
+      "globalTags",
+      "dataPlatformInstance",
+      "browsePathsV2",
+      "structuredProperties",
+      "forms",
+      "testResults",
+      "share",
+      "origin",
+      "lineageFeatures",
+      "documentation"
+    ]
+  },
+  "name": "MLModelGroupKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "platform",
+      "doc": "Standardized platform urn for the model group",
+      "Urn": "Urn"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "Name of the MLModelGroup"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL",
+        "queryByDefault": false
+      },
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "CORP": "Designates corporation fabrics",
+          "DEV": "Designates development fabrics",
+          "EI": "Designates early-integration fabrics",
+          "NON_PROD": "Designates non-production fabrics",
+          "PRD": "Alternative Prod spelling",
+          "PRE": "Designates pre-production fabrics",
+          "PROD": "Designates production fabrics",
+          "QA": "Designates quality assurance fabrics",
+          "RVW": "Designates review fabrics",
+          "SANDBOX": "Designates sandbox fabrics",
+          "STG": "Designates staging fabrics",
+          "TEST": "Designates testing fabrics",
+          "TST": "Alternative Test spelling",
+          "UAT": "Designates user acceptance testing fabrics"
+        },
+        "name": "FabricType",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "symbols": [
+          "DEV",
+          "TEST",
+          "QA",
+          "UAT",
+          "EI",
+          "PRE",
+          "STG",
+          "NON_PROD",
+          "PROD",
+          "CORP",
+          "RVW",
+          "PRD",
+          "TST",
+          "SANDBOX"
+        ],
+        "doc": "Fabric group type"
+      },
+      "name": "origin",
+      "doc": "Fabric type where model group belongs to or where it was generated"
+    }
+  ],
+  "doc": "Key for an ML model group"
+}