Skip to content

feat: Adds description attribute for features/fields #3425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
feast-ci-bot merged 2 commits into from
Jan 1, 2023
Merged

feat: Adds description attribute for features/fields #3425

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf98b82
Adding description as a first-class attribute for features/fields
amommendes Dec 31, 2022
85b9251
Formatting
amommendes Jan 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Formatting 
Signed-off-by: Amom Mendes <amommendes@hotmail.com>
  • Loading branch information
@amommendes
amommendes committed Jan 1, 2023
commit 85b92518e3e1a90d7904c14166f3ad899a2eb0ac
12 changes: 10 additions & 2 deletions sdk/python/feast/field.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,12 @@ def __str__(self):
def to_proto(self) -> FieldProto:
"""Converts a Field object to its protobuf representation."""
value_type = self.dtype.to_value_type()
return FieldProto(name=self.name, value_type=value_type.value, description=self.description, tags=self.tags)
return FieldProto(
name=self.name,
value_type=value_type.value,
description=self.description,
tags=self.tags,
)

@classmethod
def from_proto(cls, field_proto: FieldProto):
Expand All @@ -111,5 +116,8 @@ def from_feature(cls, feature: Feature):
feature: Feature object to convert.
"""
return cls(
name=feature.name, dtype=from_value_type(feature.dtype), description=feature.description, tags=feature.labels
name=feature.name,
dtype=from_value_type(feature.dtype),
description=feature.description,
tags=feature.labels,
)
18 changes: 12 additions & 6 deletions sdk/python/tests/unit/test_feature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@


from feast.field import Feature, Field
from feast.types import Float32
from feast.value_type import ValueType


def test_feature_serialization_with_description():
expected_description = "Average daily trips"
feature = Feature(name="avg_daily_trips", dtype=ValueType.FLOAT, description=expected_description)
feature = Feature(
name="avg_daily_trips", dtype=ValueType.FLOAT, description=expected_description
)
serialized_feature = feature.to_proto()

assert serialized_feature.description == expected_description


def test_field_serialization_with_description():
expected_description = "Average daily trips"
field = Field(name="avg_daily_trips", dtype=Float32, description=expected_description)
feature = Feature(name="avg_daily_trips", dtype=ValueType.FLOAT, description=expected_description)
field = Field(
name="avg_daily_trips", dtype=Float32, description=expected_description
)
feature = Feature(
name="avg_daily_trips", dtype=ValueType.FLOAT, description=expected_description
)

serialized_field = field.to_proto()
field_from_feature = Field.from_feature(feature)

assert serialized_field.description == expected_description
assert field_from_feature.description == expected_description
assert field_from_feature.description == expected_description