Skip to content

feature: Add methods for feature group to list feature metadata parameters and tags #3654

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.

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
merged 2 commits into from
Apr 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 38 additions & 2 deletions doc/api/prep_data/feature_store.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Feature Store APIs
------------------

Feature group
Feature Group
*************

.. autoclass:: sagemaker.feature_store.feature_group.FeatureGroup
Expand All @@ -18,7 +18,7 @@ Feature group
:show-inheritance:


Feature definition
Feature Definition
******************

.. autoclass:: sagemaker.feature_store.feature_definition.FeatureDefinition
Expand Down Expand Up @@ -77,10 +77,46 @@ Inputs
:members:
:show-inheritance:

.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
:members:
:show-inheritance:

.. autoclass:: sagemaker.feature_store.inputs.SearchOperatorEnum
:members:
:show-inheritance:

.. autoclass:: sagemaker.feature_store.inputs.SortOrderEnum
:members:
:show-inheritance:

.. autoclass:: sagemaker.feature_store.inputs.FilterOperatorEnum
:members:
:show-inheritance:

.. autoclass:: sagemaker.feature_store.inputs.Filter
:members:
:show-inheritance:

.. autoclass:: sagemaker.feature_store.inputs.Identifier
:members:
:show-inheritance:

.. autoclass:: sagemaker.feature_store.inputs.FeatureParameter
:members:
:show-inheritance:


Dataset Builder
***************

.. autoclass:: sagemaker.feature_store.dataset_builder.DatasetBuilder
:members:
:show-inheritance:


Feature Store
*************

.. autoclass:: sagemaker.feature_store.feature_store.FeatureStore
:members:
:show-inheritance:
26 changes: 26 additions & 0 deletions src/sagemaker/feature_store/feature_group.py
Original file line number Diff line number Diff line change
Expand Up @@ -665,6 +665,32 @@ def describe_feature_metadata(self, feature_name: str) -> Dict[str, Any]:
feature_group_name=self.name, feature_name=feature_name
)

def list_tags(self) -> Sequence[Dict[str, str]]:
"""List all tags for a feature group.

Returns:
list of key, value pair of the tags.
"""

feature_group_arn = self.sagemaker_session.describe_feature_group(
feature_group_name=self.name
).get("FeatureGroupArn")

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: might consider null pointer but I think it's unlikely to get a null with a successful call.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is unnecessary since FeatureGroupArn is a required field if describeFG returns without throwing errors.


return self.sagemaker_session.list_tags(resource_arn=feature_group_arn)

def list_parameters_for_feature_metadata(self, feature_name: str) -> Sequence[Dict[str, str]]:
"""List all parameters for a feature metadata.

Args:
feature_name (str): name of the feature.
Returns:
list of key, value pair of the parameters.
"""

return self.sagemaker_session.describe_feature_metadata(
feature_group_name=self.name, feature_name=feature_name
).get("Parameters")

def load_feature_definitions(
self,
data_frame: DataFrame,
Expand Down
10 changes: 9 additions & 1 deletion tests/integ/test_feature_store.py
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,10 @@ def test_create_feature_store_online_only(
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
tags=[{"Key": "key1", "Value": "value1"}],
)
_wait_for_feature_group_create(feature_group)

assert feature_group.list_tags() == [{"Key": "key1", "Value": "value1"}]
assert output["FeatureGroupArn"].endswith(f"feature-group/{feature_group_name}")


Expand Down Expand Up @@ -519,6 +520,10 @@ def test_feature_metadata(
print(describe_feature_metadata)
assert description == describe_feature_metadata.get("Description")
assert 2 == len(describe_feature_metadata.get("Parameters"))
assert [
{"Key": "key1", "Value": "value1"},
{"Key": "key2", "Value": "value2"},
] == feature_group.list_parameters_for_feature_metadata(feature_name=feature_name)

parameter_removals = ["key1"]
feature_group.update_feature_metadata(
Expand All @@ -529,6 +534,9 @@ def test_feature_metadata(
)
assert description == describe_feature_metadata.get("Description")
assert 1 == len(describe_feature_metadata.get("Parameters"))
assert [
{"Key": "key2", "Value": "value2"}
] == feature_group.list_parameters_for_feature_metadata(feature_name=feature_name)


def test_search(feature_store_session, role, feature_group_name, pandas_data_frame):
Expand Down
19 changes: 19 additions & 0 deletions tests/unit/sagemaker/feature_store/test_feature_group.py
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,25 @@ def test_load_feature_definition_unsupported_types(sagemaker_session_mock):
assert "Failed to infer Feature type based on dtype bool for column bool." in str(error)


def test_list_tags(sagemaker_session_mock):
feature_group = FeatureGroup(name="MyFeatureGroup", sagemaker_session=sagemaker_session_mock)
sagemaker_session_mock.describe_feature_group.return_value = {"FeatureGroupArn": "test-arn"}
feature_group.list_tags()
sagemaker_session_mock.list_tags.assert_called_with(resource_arn="test-arn")


def test_list_parameters_for_feature_metadata(sagemaker_session_mock):
feature_group = FeatureGroup(name="MyFeatureGroup", sagemaker_session=sagemaker_session_mock)
test_feature_metadata = {"Parameters": [{"Key": "k", "Value": "y"}]}
sagemaker_session_mock.describe_feature_metadata.return_value = test_feature_metadata
assert feature_group.list_parameters_for_feature_metadata(feature_name="feature") == [
{"Key": "k", "Value": "y"}
]
sagemaker_session_mock.describe_feature_metadata.assert_called_with(
feature_group_name="MyFeatureGroup", feature_name="feature"
)


def test_ingest_zero_processes():
feature_group = FeatureGroup(name="MyGroup", sagemaker_session=sagemaker_session_mock)
df = Mock()
Expand Down