File size: 13,330 Bytes
4021124 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 | # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""This module contains code to query SageMaker lineage."""
from __future__ import absolute_import
from datetime import datetime
from enum import Enum
from typing import Optional, Union, List, Dict
from sagemaker.lineage._utils import get_resource_name_from_arn
class LineageEntityEnum(Enum):
"""Enum of lineage entities for use in a query filter."""
TRIAL = "Trial"
ACTION = "Action"
ARTIFACT = "Artifact"
CONTEXT = "Context"
TRIAL_COMPONENT = "TrialComponent"
class LineageSourceEnum(Enum):
"""Enum of lineage types for use in a query filter."""
CHECKPOINT = "Checkpoint"
DATASET = "DataSet"
ENDPOINT = "Endpoint"
IMAGE = "Image"
MODEL = "Model"
MODEL_DATA = "ModelData"
MODEL_DEPLOYMENT = "ModelDeployment"
MODEL_GROUP = "ModelGroup"
MODEL_REPLACE = "ModelReplaced"
TENSORBOARD = "TensorBoard"
TRAINING_JOB = "TrainingJob"
APPROVAL = "Approval"
PROCESSING_JOB = "ProcessingJob"
TRANSFORM_JOB = "TransformJob"
class LineageQueryDirectionEnum(Enum):
"""Enum of query filter directions."""
BOTH = "Both"
ASCENDANTS = "Ascendants"
DESCENDANTS = "Descendants"
class Edge:
"""A connecting edge for a lineage graph."""
def __init__(
self,
source_arn: str,
destination_arn: str,
association_type: str,
):
"""Initialize ``Edge`` instance."""
self.source_arn = source_arn
self.destination_arn = destination_arn
self.association_type = association_type
def __hash__(self):
"""Define hash function for ``Edge``."""
return hash(
(
"source_arn",
self.source_arn,
"destination_arn",
self.destination_arn,
"association_type",
self.association_type,
)
)
def __eq__(self, other):
"""Define equal function for ``Edge``."""
return (
self.association_type == other.association_type
and self.source_arn == other.source_arn
and self.destination_arn == other.destination_arn
)
class Vertex:
"""A vertex for a lineage graph."""
def __init__(
self,
arn: str,
lineage_entity: str,
lineage_source: str,
sagemaker_session,
):
"""Initialize ``Vertex`` instance."""
self.arn = arn
self.lineage_entity = lineage_entity
self.lineage_source = lineage_source
self._session = sagemaker_session
def __hash__(self):
"""Define hash function for ``Vertex``."""
return hash(
(
"arn",
self.arn,
"lineage_entity",
self.lineage_entity,
"lineage_source",
self.lineage_source,
)
)
def __eq__(self, other):
"""Define equal function for ``Vertex``."""
return (
self.arn == other.arn
and self.lineage_entity == other.lineage_entity
and self.lineage_source == other.lineage_source
)
def to_lineage_object(self):
"""Convert the ``Vertex`` object to its corresponding lineage object.
Returns:
A ``Vertex`` object to its corresponding ``Artifact``,``Action``, ``Context``
or ``TrialComponent`` object.
"""
from sagemaker.lineage.context import Context, EndpointContext
from sagemaker.lineage.action import Action
from sagemaker.lineage.lineage_trial_component import LineageTrialComponent
if self.lineage_entity == LineageEntityEnum.CONTEXT.value:
resource_name = get_resource_name_from_arn(self.arn)
if self.lineage_source == LineageSourceEnum.ENDPOINT.value:
return EndpointContext.load(
context_name=resource_name, sagemaker_session=self._session
)
return Context.load(context_name=resource_name, sagemaker_session=self._session)
if self.lineage_entity == LineageEntityEnum.ARTIFACT.value:
return self._artifact_to_lineage_object()
if self.lineage_entity == LineageEntityEnum.ACTION.value:
return Action.load(action_name=self.arn.split("/")[1], sagemaker_session=self._session)
if self.lineage_entity == LineageEntityEnum.TRIAL_COMPONENT.value:
trial_component_name = get_resource_name_from_arn(self.arn)
return LineageTrialComponent.load(
trial_component_name=trial_component_name, sagemaker_session=self._session
)
raise ValueError("Vertex cannot be converted to a lineage object.")
def _artifact_to_lineage_object(self):
"""Convert the ``Vertex`` object to its corresponding ``Artifact``."""
from sagemaker.lineage.artifact import Artifact, ModelArtifact, ImageArtifact
from sagemaker.lineage.artifact import DatasetArtifact
if self.lineage_source == LineageSourceEnum.MODEL.value:
return ModelArtifact.load(artifact_arn=self.arn, sagemaker_session=self._session)
if self.lineage_source == LineageSourceEnum.DATASET.value:
return DatasetArtifact.load(artifact_arn=self.arn, sagemaker_session=self._session)
if self.lineage_source == LineageSourceEnum.IMAGE.value:
return ImageArtifact.load(artifact_arn=self.arn, sagemaker_session=self._session)
return Artifact.load(artifact_arn=self.arn, sagemaker_session=self._session)
class LineageQueryResult(object):
"""A wrapper around the results of a lineage query."""
def __init__(
self,
edges: List[Edge] = None,
vertices: List[Vertex] = None,
):
"""Init for LineageQueryResult.
Args:
edges (List[Edge]): The edges of the query result.
vertices (List[Vertex]): The vertices of the query result.
"""
self.edges = []
self.vertices = []
if edges is not None:
self.edges = edges
if vertices is not None:
self.vertices = vertices
class LineageFilter(object):
"""A filter used in a lineage query."""
def __init__(
self,
entities: Optional[List[Union[LineageEntityEnum, str]]] = None,
sources: Optional[List[Union[LineageSourceEnum, str]]] = None,
created_before: Optional[datetime] = None,
created_after: Optional[datetime] = None,
modified_before: Optional[datetime] = None,
modified_after: Optional[datetime] = None,
properties: Optional[Dict[str, str]] = None,
):
"""Initialize ``LineageFilter`` instance."""
self.entities = entities
self.sources = sources
self.created_before = created_before
self.created_after = created_after
self.modified_before = modified_before
self.modified_after = modified_after
self.properties = properties
def _to_request_dict(self):
"""Convert the lineage filter to its API representation."""
filter_request = {}
if self.sources:
filter_request["Types"] = list(
map(lambda x: x.value if isinstance(x, LineageSourceEnum) else x, self.sources)
)
if self.entities:
filter_request["LineageTypes"] = list(
map(lambda x: x.value if isinstance(x, LineageEntityEnum) else x, self.entities)
)
if self.created_before:
filter_request["CreatedBefore"] = self.created_before
if self.created_after:
filter_request["CreatedAfter"] = self.created_after
if self.modified_before:
filter_request["ModifiedBefore"] = self.modified_before
if self.modified_after:
filter_request["ModifiedAfter"] = self.modified_after
if self.properties:
filter_request["Properties"] = self.properties
return filter_request
class LineageQuery(object):
"""Creates an object used for performing lineage queries."""
def __init__(self, sagemaker_session):
"""Initialize ``LineageQuery`` instance."""
self._session = sagemaker_session
def _get_edge(self, edge):
"""Convert lineage query API response to an Edge."""
return Edge(
source_arn=edge["SourceArn"],
destination_arn=edge["DestinationArn"],
association_type=edge["AssociationType"] if "AssociationType" in edge else None,
)
def _get_vertex(self, vertex):
"""Convert lineage query API response to a Vertex."""
vertex_type = None
if "Type" in vertex:
vertex_type = vertex["Type"]
return Vertex(
arn=vertex["Arn"],
lineage_source=vertex_type,
lineage_entity=vertex["LineageType"],
sagemaker_session=self._session,
)
def _convert_api_response(self, response) -> LineageQueryResult:
"""Convert the lineage query API response to its Python representation."""
converted = LineageQueryResult()
converted.edges = [self._get_edge(edge) for edge in response["Edges"]]
converted.vertices = [self._get_vertex(vertex) for vertex in response["Vertices"]]
edge_set = set()
for edge in converted.edges:
if edge in edge_set:
converted.edges.remove(edge)
edge_set.add(edge)
vertex_set = set()
for vertex in converted.vertices:
if vertex in vertex_set:
converted.vertices.remove(vertex)
vertex_set.add(vertex)
return converted
def _collapse_cross_account_artifacts(self, query_response):
"""Collapse the duplicate vertices and edges for cross-account."""
for edge in query_response.edges:
if (
"artifact" in edge.source_arn
and "artifact" in edge.destination_arn
and edge.source_arn.split("/")[1] == edge.destination_arn.split("/")[1]
and edge.source_arn != edge.destination_arn
):
edge_source_arn = edge.source_arn
edge_destination_arn = edge.destination_arn
self._update_cross_account_edge(
edges=query_response.edges,
arn=edge_source_arn,
duplicate_arn=edge_destination_arn,
)
self._update_cross_account_vertex(
query_response=query_response, duplicate_arn=edge_destination_arn
)
# remove the duplicate edges from cross account
new_edge = [e for e in query_response.edges if not e.source_arn == e.destination_arn]
query_response.edges = new_edge
return query_response
def _update_cross_account_edge(self, edges, arn, duplicate_arn):
"""Replace the duplicate arn with arn in edges list."""
for idx, e in enumerate(edges):
if e.destination_arn == duplicate_arn:
edges[idx].destination_arn = arn
elif e.source_arn == duplicate_arn:
edges[idx].source_arn = arn
def _update_cross_account_vertex(self, query_response, duplicate_arn):
"""Remove the vertex with duplicate arn in the vertices list."""
query_response.vertices = [v for v in query_response.vertices if not v.arn == duplicate_arn]
def query(
self,
start_arns: List[str],
direction: LineageQueryDirectionEnum = LineageQueryDirectionEnum.BOTH,
include_edges: bool = True,
query_filter: LineageFilter = None,
max_depth: int = 10,
) -> LineageQueryResult:
"""Perform a lineage query.
Args:
start_arns (List[str]): A list of ARNs that will be used as the starting point
for the query.
direction (LineageQueryDirectionEnum, optional): The direction of the query.
include_edges (bool, optional): If true, return edges in addition to vertices.
query_filter (LineageQueryFilter, optional): The query filter.
Returns:
LineageQueryResult: The lineage query result.
"""
query_response = self._session.sagemaker_client.query_lineage(
StartArns=start_arns,
Direction=direction.value,
IncludeEdges=include_edges,
Filters=query_filter._to_request_dict() if query_filter else {},
MaxDepth=max_depth,
)
query_response = self._convert_api_response(query_response)
query_response = self._collapse_cross_account_artifacts(query_response)
return query_response
|