-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathfield.py
More file actions
265 lines (227 loc) · 8.96 KB
/
field.py
File metadata and controls
265 lines (227 loc) · 8.96 KB
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
# Copyright 2022 The Feast Authors
#
# 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
#
# https://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.
import json
from typing import Dict, Optional
from typeguard import typechecked
from feast.feature import Feature
from feast.protos.feast.core.Feature_pb2 import FeatureSpecV2 as FieldProto
from feast.types import FeastType, Struct, from_value_type
from feast.value_type import ValueType
STRUCT_SCHEMA_TAG = "feast:struct_schema"
@typechecked
class Field:
"""
A Field represents a set of values with the same structure.
Attributes:
name: The name of the field.
dtype: The type of the field, such as string or float.
description: A human-readable description.
tags: User-defined metadata in dictionary form.
vector_index: If set to True the field will be indexed for vector similarity search.
vector_length: The length of the vector if the vector index is set to True.
vector_search_metric: The metric used for vector similarity search.
"""
name: str
dtype: FeastType
description: str
tags: Dict[str, str]
vector_index: bool
vector_length: int
vector_search_metric: Optional[str]
def __init__(
self,
*,
name: str,
dtype: FeastType,
description: str = "",
tags: Optional[Dict[str, str]] = None,
vector_index: bool = False,
vector_length: int = 0,
vector_search_metric: Optional[str] = None,
):
"""
Creates a Field object.
Args:
name: The name of the field.
dtype: The type of the field, such as string or float.
description (optional): A human-readable description.
tags (optional): User-defined metadata in dictionary form.
vector_index (optional): If set to True the field will be indexed for vector similarity search.
vector_search_metric (optional): The metric used for vector similarity search.
"""
self.name = name
self.dtype = dtype
self.description = description
self.tags = tags or {}
self.vector_index = vector_index
self.vector_length = vector_length
self.vector_search_metric = vector_search_metric
def __eq__(self, other):
if type(self) != type(other):
return False
if (
self.name != other.name
or self.dtype != other.dtype
or self.description != other.description
or self.tags != other.tags
or self.vector_length != other.vector_length
# or self.vector_index != other.vector_index
# or self.vector_search_metric != other.vector_search_metric
):
return False
return True
def __hash__(self):
return hash((self.name, hash(self.dtype)))
def __lt__(self, other):
return self.name < other.name
def __repr__(self):
return (
f"Field(\n"
f" name={self.name!r},\n"
f" dtype={self.dtype!r},\n"
f" description={self.description!r},\n"
f" tags={self.tags!r}\n"
f" vector_index={self.vector_index!r}\n"
f" vector_length={self.vector_length!r}\n"
f" vector_search_metric={self.vector_search_metric!r}\n"
f")"
)
def __str__(self):
return f"Field(name={self.name}, dtype={self.dtype}, tags={self.tags})"
def to_proto(self) -> FieldProto:
"""Converts a Field object to its protobuf representation."""
from feast.types import Array
value_type = self.dtype.to_value_type()
vector_search_metric = self.vector_search_metric or ""
tags = dict(self.tags)
# Persist Struct field schema in tags
if isinstance(self.dtype, Struct):
tags[STRUCT_SCHEMA_TAG] = _serialize_struct_schema(self.dtype)
elif isinstance(self.dtype, Array) and isinstance(self.dtype.base_type, Struct):
tags[STRUCT_SCHEMA_TAG] = _serialize_struct_schema(self.dtype.base_type)
return FieldProto(
name=self.name,
value_type=value_type.value,
description=self.description,
tags=tags,
vector_index=self.vector_index,
vector_length=self.vector_length,
vector_search_metric=vector_search_metric,
)
@classmethod
def from_proto(cls, field_proto: FieldProto):
"""
Creates a Field object from a protobuf representation.
Args:
field_proto: FieldProto protobuf object
"""
value_type = ValueType(field_proto.value_type)
tags = dict(field_proto.tags)
vector_search_metric = getattr(field_proto, "vector_search_metric", "")
vector_index = getattr(field_proto, "vector_index", False)
vector_length = getattr(field_proto, "vector_length", 0)
# Reconstruct Struct type from persisted schema in tags
from feast.types import Array
dtype: FeastType
if value_type == ValueType.STRUCT and STRUCT_SCHEMA_TAG in tags:
dtype = _deserialize_struct_schema(tags[STRUCT_SCHEMA_TAG])
user_tags = {k: v for k, v in tags.items() if k != STRUCT_SCHEMA_TAG}
elif value_type == ValueType.STRUCT_LIST and STRUCT_SCHEMA_TAG in tags:
inner_struct = _deserialize_struct_schema(tags[STRUCT_SCHEMA_TAG])
dtype = Array(inner_struct)
user_tags = {k: v for k, v in tags.items() if k != STRUCT_SCHEMA_TAG}
else:
dtype = from_value_type(value_type=value_type)
user_tags = tags
return cls(
name=field_proto.name,
dtype=dtype,
tags=user_tags,
description=field_proto.description,
vector_index=vector_index,
vector_length=vector_length,
vector_search_metric=vector_search_metric,
)
@classmethod
def from_feature(cls, feature: Feature):
"""
Creates a Field object from a Feature object.
Args:
feature: Feature object to convert.
"""
return cls(
name=feature.name,
dtype=from_value_type(feature.dtype),
description=feature.description,
tags=feature.labels,
)
def _feast_type_to_str(feast_type: FeastType) -> str:
"""Convert a FeastType to a string representation for serialization."""
from feast.types import (
Array,
PrimitiveFeastType,
)
if isinstance(feast_type, PrimitiveFeastType):
return feast_type.name
elif isinstance(feast_type, Struct):
nested = {
name: _feast_type_to_str(ft) for name, ft in feast_type.fields.items()
}
return json.dumps({"__struct__": nested})
elif isinstance(feast_type, Array):
return f"Array({_feast_type_to_str(feast_type.base_type)})"
else:
return str(feast_type)
def _str_to_feast_type(type_str: str) -> FeastType:
"""Convert a string representation back to a FeastType."""
from feast.types import (
Array,
PrimitiveFeastType,
)
# Check if it's an Array type
if type_str.startswith("Array(") and type_str.endswith(")"):
inner = type_str[6:-1]
base_type = _str_to_feast_type(inner)
return Array(base_type)
# Check if it's a nested Struct (JSON encoded)
if type_str.startswith("{"):
try:
parsed = json.loads(type_str)
if "__struct__" in parsed:
fields = {
name: _str_to_feast_type(ft_str)
for name, ft_str in parsed["__struct__"].items()
}
return Struct(fields)
except (json.JSONDecodeError, TypeError):
pass
# Must be a PrimitiveFeastType name
try:
return PrimitiveFeastType[type_str]
except KeyError:
from feast.types import String
return String
def _serialize_struct_schema(struct_type: Struct) -> str:
"""Serialize a Struct's field schema to a JSON string for tag storage."""
schema_dict = {}
for name, feast_type in struct_type.fields.items():
schema_dict[name] = _feast_type_to_str(feast_type)
return json.dumps(schema_dict)
def _deserialize_struct_schema(schema_str: str) -> Struct:
"""Deserialize a JSON string from tags back to a Struct type."""
schema_dict = json.loads(schema_str)
fields = {}
for name, type_str in schema_dict.items():
fields[name] = _str_to_feast_type(type_str)
return Struct(fields)