-
Notifications
You must be signed in to change notification settings - Fork 706
/
base_resolver.py
79 lines (64 loc) · 2.72 KB
/
base_resolver.py
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
# Lint as: python2, python3
# Copyright 2019 Google LLC. 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.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License 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.
"""Base class for TFX resolvers."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
import abc
from typing import Dict, List, Text
from six import with_metaclass
from tfx import types
from tfx.orchestration import data_types
from tfx.orchestration import metadata
class ResolveResult(object):
"""The data structure to hold results from Resolver.
Attributes:
per_key_resolve_result: a key -> List[Artifact] dict containing the resolved
artifacts for each source channel with the key as tag.
per_key_resolve_state: a key -> bool dict containing whether or not the
resolved artifacts for the channel are considered complete.
has_complete_result: bool value indicating whether all desired artifacts
have been resolved.
"""
def __init__(self, per_key_resolve_result: Dict[Text, List[types.Artifact]],
per_key_resolve_state: Dict[Text, bool]):
self.per_key_resolve_result = per_key_resolve_result
self.per_key_resolve_state = per_key_resolve_state
self.has_complete_result = all([s for s in per_key_resolve_state.values()])
class BaseResolver(with_metaclass(abc.ABCMeta, object)):
"""Base class for resolver.
Resolver is the logical unit that will be used optionally for input selection.
A resolver subclass must override the resolve() function which takes a
read-only MLMD handler and a dict of <key, Channel> as parameters and produces
a ResolveResult instance.
"""
@abc.abstractmethod
def resolve(
self,
pipeline_info: data_types.PipelineInfo,
metadata_handler: metadata.Metadata,
source_channels: Dict[Text, types.Channel],
) -> ResolveResult:
"""Resolves artifacts from channels by querying MLMD.
Args:
pipeline_info: PipelineInfo of the current pipeline. We do not want to
query artifacts across pipeline boundary.
metadata_handler: a read-only handler to query MLMD.
source_channels: a key -> channel dict which contains the info of the
source channels.
Returns:
a ResolveResult instance.
"""
raise NotImplementedError