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
12 changes: 12 additions & 0 deletions doc/api/prep_data/feature_store.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,6 +75,14 @@ Inputs
:members:
:show-inheritance:

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

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

.. autoclass:: sagemaker.feature_store.inputs.OnlineStoreConfig
:members:
:show-inheritance:
Expand All@@ -99,6 +107,10 @@ Inputs
:members:
:show-inheritance:

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

.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
:members:
:show-inheritance:
Expand Down
17 changes: 15 additions & 2 deletions src/sagemaker/feature_store/feature_group.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputConfigUpdate,
)
from sagemaker.utils import resolve_value_from_config, format_tags, Tags

Expand DownExpand Up@@ -541,6 +543,7 @@ def create(
tags: Optional[Tags] = None,
table_format: TableFormatEnum = None,
online_store_storage_type: OnlineStoreStorageTypeEnum = None,
throughput_config: ThroughputConfig = None,
) -> Dict[str, Any]:
"""Create a SageMaker FeatureStore FeatureGroup.

Expand DownExpand Up@@ -570,6 +573,8 @@ def create(
table_format (TableFormatEnum): format of the offline store table (default: None).
online_store_storage_type (OnlineStoreStorageTypeEnum): storage type for the
online store (default: None).
throughput_config (ThroughputConfig): throughput configuration of the
feature group (default: None).

Returns:
Response dict from service.
Expand DownExpand Up@@ -618,6 +623,9 @@ def create(
)
create_feature_store_args.update({"online_store_config": online_store_config.to_dict()})

if throughput_config:
create_feature_store_args.update({"throughput_config": throughput_config.to_dict()})

# offline store configuration
if s3_uri:
s3_storage_config = S3StorageConfig(s3_uri=s3_uri)
Expand DownExpand Up@@ -656,17 +664,17 @@ def update(
self,
feature_additions: Sequence[FeatureDefinition] = None,
online_store_config: OnlineStoreConfigUpdate = None,
throughput_config: ThroughputConfigUpdate = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup and add new features from the given feature definitions.

Args:
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (OnlineStoreConfigUpdate): online store config to be updated.

throughput_config (ThroughputConfigUpdate): target throughput configuration
Returns:
Response dict from service.
"""

if feature_additions is None:
feature_additions_parameter = None
else:
Expand All@@ -679,10 +687,15 @@ def update(
else:
online_store_config_parameter = online_store_config.to_dict()

throughput_config_parameter = (
None if throughput_config is None else throughput_config.to_dict()
)

return self.sagemaker_session.update_feature_group(
feature_group_name=self.name,
feature_additions=feature_additions_parameter,
online_store_config=online_store_config_parameter,
throughput_config=throughput_config_parameter,
)

def update_feature_metadata(
Expand Down
76 changes: 76 additions & 0 deletions src/sagemaker/feature_store/inputs.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -453,3 +453,79 @@ class ExpirationTimeResponseEnum(Enum):

DISABLED = "Disabled"
ENABLED = "Enabled"


class ThroughputModeEnum(Enum):
"""Enum of throughput modes supported by feature group.

Throughput mode of feature group can be ON_DEMAND or PROVISIONED.
"""

ON_DEMAND = "OnDemand"
PROVISIONED = "Provisioned"


@attr.s
class ThroughputConfig(Config):
"""Throughput configuration of the feature group.

Throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)


@attr.s
class ThroughputConfigUpdate(Config):
"""Target throughput configuration for the feature group.

Target throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Target throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)
28 changes: 18 additions & 10 deletions src/sagemaker/session.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -5679,6 +5679,7 @@ def create_feature_group(
role_arn: str = None,
online_store_config: Dict[str, str] = None,
offline_store_config: Dict[str, str] = None,
throughput_config: Dict[str, Any] = None,
description: str = None,
tags: Optional[Tags] = None,
) -> Dict[str, Any]:
Expand All@@ -5694,6 +5695,8 @@ def create_feature_group(
feature online store.
offline_store_config (Dict[str, str]): dict contains configuration of the
feature offline store.
throughput_config (Dict[str, str]): dict contains throughput configuration
for the feature group.
description (str): description of the FeatureGroup.
tags (Optional[Tags]): tags for labeling a FeatureGroup.

Expand DownExpand Up@@ -5729,6 +5732,7 @@ def create_feature_group(
kwargs,
OnlineStoreConfig=inferred_online_store_from_config,
OfflineStoreConfig=inferred_offline_store_from_config,
ThroughputConfig=throughput_config,
Description=description,
Tags=tags,
)
Expand DownExpand Up@@ -5757,28 +5761,32 @@ def update_feature_group(
feature_group_name: str,
feature_additions: Sequence[Dict[str, str]] = None,
online_store_config: Dict[str, any] = None,
throughput_config: Dict[str, Any] = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup

either adding new features from the given feature definitions
or updating online store config
Supports modifications like adding new features from the given feature definitions,
updating online store and throughput configurations.

Args:
feature_group_name (str): name of the FeatureGroup to update.
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (Dict[str, Any]): updates to online store config
throughput_config (Dict[str, Any]): target throughput configuration of the feature group
Returns:
Response dict from service.
"""
update_req = {"FeatureGroupName": feature_group_name}
if online_store_config is not None:
update_req["OnlineStoreConfig"] = online_store_config

if feature_additions is None:
return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name,
OnlineStoreConfig=online_store_config,
)
if throughput_config is not None:
update_req["ThroughputConfig"] = throughput_config

return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name, FeatureAdditions=feature_additions
)
if feature_additions is not None:
update_req["FeatureAdditions"] = feature_additions

return self.sagemaker_client.update_feature_group(**update_req)

def list_feature_groups(
self,
Expand Down
75 changes: 75 additions & 0 deletions tests/integ/test_feature_store.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,9 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputModeEnum,
ThroughputConfigUpdate,
)
from sagemaker.feature_store.dataset_builder import (
JoinTypeEnum,
Expand DownExpand Up@@ -410,6 +413,78 @@ def test_create_feature_group_standard_storage_type(
assert storage_type == "Standard"


def test_throughput_create_as_provisioned_and_update_to_ondemand(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.PROVISIONED, 4000, 4000),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 4000
assert wcu == 4000

feature_group.update(throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.ON_DEMAND))
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value


def test_throughput_create_as_ondemand_and_update_to_provisioned(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.ON_DEMAND),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value

feature_group.update(
throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.PROVISIONED, 100, 200)
)
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 100
assert wcu == 200


def test_ttl_duration(
feature_store_session,
role,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
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
12 changes: 12 additions & 0 deletions doc/api/prep_data/feature_store.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,6 +75,14 @@ Inputs
:members:
:show-inheritance:

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

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

.. autoclass:: sagemaker.feature_store.inputs.OnlineStoreConfig
:members:
:show-inheritance:
Expand All@@ -99,6 +107,10 @@ Inputs
:members:
:show-inheritance:

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

.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
:members:
:show-inheritance:
Expand Down
17 changes: 15 additions & 2 deletions src/sagemaker/feature_store/feature_group.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputConfigUpdate,
)
from sagemaker.utils import resolve_value_from_config, format_tags, Tags

Expand DownExpand Up@@ -541,6 +543,7 @@ def create(
tags: Optional[Tags] = None,
table_format: TableFormatEnum = None,
online_store_storage_type: OnlineStoreStorageTypeEnum = None,
throughput_config: ThroughputConfig = None,
) -> Dict[str, Any]:
"""Create a SageMaker FeatureStore FeatureGroup.

Expand DownExpand Up@@ -570,6 +573,8 @@ def create(
table_format (TableFormatEnum): format of the offline store table (default: None).
online_store_storage_type (OnlineStoreStorageTypeEnum): storage type for the
online store (default: None).
throughput_config (ThroughputConfig): throughput configuration of the
feature group (default: None).

Returns:
Response dict from service.
Expand DownExpand Up@@ -618,6 +623,9 @@ def create(
)
create_feature_store_args.update({"online_store_config": online_store_config.to_dict()})

if throughput_config:
create_feature_store_args.update({"throughput_config": throughput_config.to_dict()})

# offline store configuration
if s3_uri:
s3_storage_config = S3StorageConfig(s3_uri=s3_uri)
Expand DownExpand Up@@ -656,17 +664,17 @@ def update(
self,
feature_additions: Sequence[FeatureDefinition] = None,
online_store_config: OnlineStoreConfigUpdate = None,
throughput_config: ThroughputConfigUpdate = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup and add new features from the given feature definitions.

Args:
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (OnlineStoreConfigUpdate): online store config to be updated.

throughput_config (ThroughputConfigUpdate): target throughput configuration
Returns:
Response dict from service.
"""

if feature_additions is None:
feature_additions_parameter = None
else:
Expand All@@ -679,10 +687,15 @@ def update(
else:
online_store_config_parameter = online_store_config.to_dict()

throughput_config_parameter = (
None if throughput_config is None else throughput_config.to_dict()
)

return self.sagemaker_session.update_feature_group(
feature_group_name=self.name,
feature_additions=feature_additions_parameter,
online_store_config=online_store_config_parameter,
throughput_config=throughput_config_parameter,
)

def update_feature_metadata(
Expand Down
76 changes: 76 additions & 0 deletions src/sagemaker/feature_store/inputs.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -453,3 +453,79 @@ class ExpirationTimeResponseEnum(Enum):

DISABLED = "Disabled"
ENABLED = "Enabled"


class ThroughputModeEnum(Enum):
"""Enum of throughput modes supported by feature group.

Throughput mode of feature group can be ON_DEMAND or PROVISIONED.
"""

ON_DEMAND = "OnDemand"
PROVISIONED = "Provisioned"


@attr.s
class ThroughputConfig(Config):
"""Throughput configuration of the feature group.

Throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)


@attr.s
class ThroughputConfigUpdate(Config):
"""Target throughput configuration for the feature group.

Target throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Target throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)
28 changes: 18 additions & 10 deletions src/sagemaker/session.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -5679,6 +5679,7 @@ def create_feature_group(
role_arn: str = None,
online_store_config: Dict[str, str] = None,
offline_store_config: Dict[str, str] = None,
throughput_config: Dict[str, Any] = None,
description: str = None,
tags: Optional[Tags] = None,
) -> Dict[str, Any]:
Expand All@@ -5694,6 +5695,8 @@ def create_feature_group(
feature online store.
offline_store_config (Dict[str, str]): dict contains configuration of the
feature offline store.
throughput_config (Dict[str, str]): dict contains throughput configuration
for the feature group.
description (str): description of the FeatureGroup.
tags (Optional[Tags]): tags for labeling a FeatureGroup.

Expand DownExpand Up@@ -5729,6 +5732,7 @@ def create_feature_group(
kwargs,
OnlineStoreConfig=inferred_online_store_from_config,
OfflineStoreConfig=inferred_offline_store_from_config,
ThroughputConfig=throughput_config,
Description=description,
Tags=tags,
)
Expand DownExpand Up@@ -5757,28 +5761,32 @@ def update_feature_group(
feature_group_name: str,
feature_additions: Sequence[Dict[str, str]] = None,
online_store_config: Dict[str, any] = None,
throughput_config: Dict[str, Any] = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup

either adding new features from the given feature definitions
or updating online store config
Supports modifications like adding new features from the given feature definitions,
updating online store and throughput configurations.

Args:
feature_group_name (str): name of the FeatureGroup to update.
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (Dict[str, Any]): updates to online store config
throughput_config (Dict[str, Any]): target throughput configuration of the feature group
Returns:
Response dict from service.
"""
update_req = {"FeatureGroupName": feature_group_name}
if online_store_config is not None:
update_req["OnlineStoreConfig"] = online_store_config

if feature_additions is None:
return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name,
OnlineStoreConfig=online_store_config,
)
if throughput_config is not None:
update_req["ThroughputConfig"] = throughput_config

return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name, FeatureAdditions=feature_additions
)
if feature_additions is not None:
update_req["FeatureAdditions"] = feature_additions

return self.sagemaker_client.update_feature_group(**update_req)

def list_feature_groups(
self,
Expand Down
75 changes: 75 additions & 0 deletions tests/integ/test_feature_store.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,9 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputModeEnum,
ThroughputConfigUpdate,
)
from sagemaker.feature_store.dataset_builder import (
JoinTypeEnum,
Expand DownExpand Up@@ -410,6 +413,78 @@ def test_create_feature_group_standard_storage_type(
assert storage_type == "Standard"


def test_throughput_create_as_provisioned_and_update_to_ondemand(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.PROVISIONED, 4000, 4000),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 4000
assert wcu == 4000

feature_group.update(throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.ON_DEMAND))
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value


def test_throughput_create_as_ondemand_and_update_to_provisioned(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.ON_DEMAND),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value

feature_group.update(
throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.PROVISIONED, 100, 200)
)
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 100
assert wcu == 200


def test_ttl_duration(
feature_store_session,
role,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
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
12 changes: 12 additions & 0 deletions doc/api/prep_data/feature_store.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,6 +75,14 @@ Inputs
:members:
:show-inheritance:

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

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

.. autoclass:: sagemaker.feature_store.inputs.OnlineStoreConfig
:members:
:show-inheritance:
Expand All@@ -99,6 +107,10 @@ Inputs
:members:
:show-inheritance:

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

.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
:members:
:show-inheritance:
Expand Down
17 changes: 15 additions & 2 deletions src/sagemaker/feature_store/feature_group.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputConfigUpdate,
)
from sagemaker.utils import resolve_value_from_config, format_tags, Tags

Expand DownExpand Up@@ -541,6 +543,7 @@ def create(
tags: Optional[Tags] = None,
table_format: TableFormatEnum = None,
online_store_storage_type: OnlineStoreStorageTypeEnum = None,
throughput_config: ThroughputConfig = None,
) -> Dict[str, Any]:
"""Create a SageMaker FeatureStore FeatureGroup.

Expand DownExpand Up@@ -570,6 +573,8 @@ def create(
table_format (TableFormatEnum): format of the offline store table (default: None).
online_store_storage_type (OnlineStoreStorageTypeEnum): storage type for the
online store (default: None).
throughput_config (ThroughputConfig): throughput configuration of the
feature group (default: None).

Returns:
Response dict from service.
Expand DownExpand Up@@ -618,6 +623,9 @@ def create(
)
create_feature_store_args.update({"online_store_config": online_store_config.to_dict()})

if throughput_config:
create_feature_store_args.update({"throughput_config": throughput_config.to_dict()})

# offline store configuration
if s3_uri:
s3_storage_config = S3StorageConfig(s3_uri=s3_uri)
Expand DownExpand Up@@ -656,17 +664,17 @@ def update(
self,
feature_additions: Sequence[FeatureDefinition] = None,
online_store_config: OnlineStoreConfigUpdate = None,
throughput_config: ThroughputConfigUpdate = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup and add new features from the given feature definitions.

Args:
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (OnlineStoreConfigUpdate): online store config to be updated.

throughput_config (ThroughputConfigUpdate): target throughput configuration
Returns:
Response dict from service.
"""

if feature_additions is None:
feature_additions_parameter = None
else:
Expand All@@ -679,10 +687,15 @@ def update(
else:
online_store_config_parameter = online_store_config.to_dict()

throughput_config_parameter = (
None if throughput_config is None else throughput_config.to_dict()
)

return self.sagemaker_session.update_feature_group(
feature_group_name=self.name,
feature_additions=feature_additions_parameter,
online_store_config=online_store_config_parameter,
throughput_config=throughput_config_parameter,
)

def update_feature_metadata(
Expand Down
76 changes: 76 additions & 0 deletions src/sagemaker/feature_store/inputs.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -453,3 +453,79 @@ class ExpirationTimeResponseEnum(Enum):

DISABLED = "Disabled"
ENABLED = "Enabled"


class ThroughputModeEnum(Enum):
"""Enum of throughput modes supported by feature group.

Throughput mode of feature group can be ON_DEMAND or PROVISIONED.
"""

ON_DEMAND = "OnDemand"
PROVISIONED = "Provisioned"


@attr.s
class ThroughputConfig(Config):
"""Throughput configuration of the feature group.

Throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)


@attr.s
class ThroughputConfigUpdate(Config):
"""Target throughput configuration for the feature group.

Target throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Target throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)
28 changes: 18 additions & 10 deletions src/sagemaker/session.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -5679,6 +5679,7 @@ def create_feature_group(
role_arn: str = None,
online_store_config: Dict[str, str] = None,
offline_store_config: Dict[str, str] = None,
throughput_config: Dict[str, Any] = None,
description: str = None,
tags: Optional[Tags] = None,
) -> Dict[str, Any]:
Expand All@@ -5694,6 +5695,8 @@ def create_feature_group(
feature online store.
offline_store_config (Dict[str, str]): dict contains configuration of the
feature offline store.
throughput_config (Dict[str, str]): dict contains throughput configuration
for the feature group.
description (str): description of the FeatureGroup.
tags (Optional[Tags]): tags for labeling a FeatureGroup.

Expand DownExpand Up@@ -5729,6 +5732,7 @@ def create_feature_group(
kwargs,
OnlineStoreConfig=inferred_online_store_from_config,
OfflineStoreConfig=inferred_offline_store_from_config,
ThroughputConfig=throughput_config,
Description=description,
Tags=tags,
)
Expand DownExpand Up@@ -5757,28 +5761,32 @@ def update_feature_group(
feature_group_name: str,
feature_additions: Sequence[Dict[str, str]] = None,
online_store_config: Dict[str, any] = None,
throughput_config: Dict[str, Any] = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup

either adding new features from the given feature definitions
or updating online store config
Supports modifications like adding new features from the given feature definitions,
updating online store and throughput configurations.

Args:
feature_group_name (str): name of the FeatureGroup to update.
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (Dict[str, Any]): updates to online store config
throughput_config (Dict[str, Any]): target throughput configuration of the feature group
Returns:
Response dict from service.
"""
update_req = {"FeatureGroupName": feature_group_name}
if online_store_config is not None:
update_req["OnlineStoreConfig"] = online_store_config

if feature_additions is None:
return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name,
OnlineStoreConfig=online_store_config,
)
if throughput_config is not None:
update_req["ThroughputConfig"] = throughput_config

return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name, FeatureAdditions=feature_additions
)
if feature_additions is not None:
update_req["FeatureAdditions"] = feature_additions

return self.sagemaker_client.update_feature_group(**update_req)

def list_feature_groups(
self,
Expand Down
75 changes: 75 additions & 0 deletions tests/integ/test_feature_store.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,9 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputModeEnum,
ThroughputConfigUpdate,
)
from sagemaker.feature_store.dataset_builder import (
JoinTypeEnum,
Expand DownExpand Up@@ -410,6 +413,78 @@ def test_create_feature_group_standard_storage_type(
assert storage_type == "Standard"


def test_throughput_create_as_provisioned_and_update_to_ondemand(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.PROVISIONED, 4000, 4000),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 4000
assert wcu == 4000

feature_group.update(throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.ON_DEMAND))
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value


def test_throughput_create_as_ondemand_and_update_to_provisioned(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.ON_DEMAND),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value

feature_group.update(
throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.PROVISIONED, 100, 200)
)
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 100
assert wcu == 200


def test_ttl_duration(
feature_store_session,
role,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
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
12 changes: 12 additions & 0 deletions doc/api/prep_data/feature_store.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,6 +75,14 @@ Inputs
:members:
:show-inheritance:

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

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

.. autoclass:: sagemaker.feature_store.inputs.OnlineStoreConfig
:members:
:show-inheritance:
Expand All@@ -99,6 +107,10 @@ Inputs
:members:
:show-inheritance:

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

.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
:members:
:show-inheritance:
Expand Down
17 changes: 15 additions & 2 deletions src/sagemaker/feature_store/feature_group.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputConfigUpdate,
)
from sagemaker.utils import resolve_value_from_config, format_tags, Tags

Expand DownExpand Up@@ -541,6 +543,7 @@ def create(
tags: Optional[Tags] = None,
table_format: TableFormatEnum = None,
online_store_storage_type: OnlineStoreStorageTypeEnum = None,
throughput_config: ThroughputConfig = None,
) -> Dict[str, Any]:
"""Create a SageMaker FeatureStore FeatureGroup.

Expand DownExpand Up@@ -570,6 +573,8 @@ def create(
table_format (TableFormatEnum): format of the offline store table (default: None).
online_store_storage_type (OnlineStoreStorageTypeEnum): storage type for the
online store (default: None).
throughput_config (ThroughputConfig): throughput configuration of the
feature group (default: None).

Returns:
Response dict from service.
Expand DownExpand Up@@ -618,6 +623,9 @@ def create(
)
create_feature_store_args.update({"online_store_config": online_store_config.to_dict()})

if throughput_config:
create_feature_store_args.update({"throughput_config": throughput_config.to_dict()})

# offline store configuration
if s3_uri:
s3_storage_config = S3StorageConfig(s3_uri=s3_uri)
Expand DownExpand Up@@ -656,17 +664,17 @@ def update(
self,
feature_additions: Sequence[FeatureDefinition] = None,
online_store_config: OnlineStoreConfigUpdate = None,
throughput_config: ThroughputConfigUpdate = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup and add new features from the given feature definitions.

Args:
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (OnlineStoreConfigUpdate): online store config to be updated.

throughput_config (ThroughputConfigUpdate): target throughput configuration
Returns:
Response dict from service.
"""

if feature_additions is None:
feature_additions_parameter = None
else:
Expand All@@ -679,10 +687,15 @@ def update(
else:
online_store_config_parameter = online_store_config.to_dict()

throughput_config_parameter = (
None if throughput_config is None else throughput_config.to_dict()
)

return self.sagemaker_session.update_feature_group(
feature_group_name=self.name,
feature_additions=feature_additions_parameter,
online_store_config=online_store_config_parameter,
throughput_config=throughput_config_parameter,
)

def update_feature_metadata(
Expand Down
76 changes: 76 additions & 0 deletions src/sagemaker/feature_store/inputs.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -453,3 +453,79 @@ class ExpirationTimeResponseEnum(Enum):

DISABLED = "Disabled"
ENABLED = "Enabled"


class ThroughputModeEnum(Enum):
"""Enum of throughput modes supported by feature group.

Throughput mode of feature group can be ON_DEMAND or PROVISIONED.
"""

ON_DEMAND = "OnDemand"
PROVISIONED = "Provisioned"


@attr.s
class ThroughputConfig(Config):
"""Throughput configuration of the feature group.

Throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)


@attr.s
class ThroughputConfigUpdate(Config):
"""Target throughput configuration for the feature group.

Target throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Target throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)
28 changes: 18 additions & 10 deletions src/sagemaker/session.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -5679,6 +5679,7 @@ def create_feature_group(
role_arn: str = None,
online_store_config: Dict[str, str] = None,
offline_store_config: Dict[str, str] = None,
throughput_config: Dict[str, Any] = None,
description: str = None,
tags: Optional[Tags] = None,
) -> Dict[str, Any]:
Expand All@@ -5694,6 +5695,8 @@ def create_feature_group(
feature online store.
offline_store_config (Dict[str, str]): dict contains configuration of the
feature offline store.
throughput_config (Dict[str, str]): dict contains throughput configuration
for the feature group.
description (str): description of the FeatureGroup.
tags (Optional[Tags]): tags for labeling a FeatureGroup.

Expand DownExpand Up@@ -5729,6 +5732,7 @@ def create_feature_group(
kwargs,
OnlineStoreConfig=inferred_online_store_from_config,
OfflineStoreConfig=inferred_offline_store_from_config,
ThroughputConfig=throughput_config,
Description=description,
Tags=tags,
)
Expand DownExpand Up@@ -5757,28 +5761,32 @@ def update_feature_group(
feature_group_name: str,
feature_additions: Sequence[Dict[str, str]] = None,
online_store_config: Dict[str, any] = None,
throughput_config: Dict[str, Any] = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup

either adding new features from the given feature definitions
or updating online store config
Supports modifications like adding new features from the given feature definitions,
updating online store and throughput configurations.

Args:
feature_group_name (str): name of the FeatureGroup to update.
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (Dict[str, Any]): updates to online store config
throughput_config (Dict[str, Any]): target throughput configuration of the feature group
Returns:
Response dict from service.
"""
update_req = {"FeatureGroupName": feature_group_name}
if online_store_config is not None:
update_req["OnlineStoreConfig"] = online_store_config

if feature_additions is None:
return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name,
OnlineStoreConfig=online_store_config,
)
if throughput_config is not None:
update_req["ThroughputConfig"] = throughput_config

return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name, FeatureAdditions=feature_additions
)
if feature_additions is not None:
update_req["FeatureAdditions"] = feature_additions

return self.sagemaker_client.update_feature_group(**update_req)

def list_feature_groups(
self,
Expand Down
75 changes: 75 additions & 0 deletions tests/integ/test_feature_store.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,9 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputModeEnum,
ThroughputConfigUpdate,
)
from sagemaker.feature_store.dataset_builder import (
JoinTypeEnum,
Expand DownExpand Up@@ -410,6 +413,78 @@ def test_create_feature_group_standard_storage_type(
assert storage_type == "Standard"


def test_throughput_create_as_provisioned_and_update_to_ondemand(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.PROVISIONED, 4000, 4000),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 4000
assert wcu == 4000

feature_group.update(throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.ON_DEMAND))
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value


def test_throughput_create_as_ondemand_and_update_to_provisioned(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.ON_DEMAND),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value

feature_group.update(
throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.PROVISIONED, 100, 200)
)
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 100
assert wcu == 200


def test_ttl_duration(
feature_store_session,
role,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
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
12 changes: 12 additions & 0 deletions doc/api/prep_data/feature_store.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,6 +75,14 @@ Inputs
:members:
:show-inheritance:

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

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

.. autoclass:: sagemaker.feature_store.inputs.OnlineStoreConfig
:members:
:show-inheritance:
Expand All@@ -99,6 +107,10 @@ Inputs
:members:
:show-inheritance:

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

.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
:members:
:show-inheritance:
Expand Down
17 changes: 15 additions & 2 deletions src/sagemaker/feature_store/feature_group.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputConfigUpdate,
)
from sagemaker.utils import resolve_value_from_config, format_tags, Tags

Expand DownExpand Up@@ -541,6 +543,7 @@ def create(
tags: Optional[Tags] = None,
table_format: TableFormatEnum = None,
online_store_storage_type: OnlineStoreStorageTypeEnum = None,
throughput_config: ThroughputConfig = None,
) -> Dict[str, Any]:
"""Create a SageMaker FeatureStore FeatureGroup.

Expand DownExpand Up@@ -570,6 +573,8 @@ def create(
table_format (TableFormatEnum): format of the offline store table (default: None).
online_store_storage_type (OnlineStoreStorageTypeEnum): storage type for the
online store (default: None).
throughput_config (ThroughputConfig): throughput configuration of the
feature group (default: None).

Returns:
Response dict from service.
Expand DownExpand Up@@ -618,6 +623,9 @@ def create(
)
create_feature_store_args.update({"online_store_config": online_store_config.to_dict()})

if throughput_config:
create_feature_store_args.update({"throughput_config": throughput_config.to_dict()})

# offline store configuration
if s3_uri:
s3_storage_config = S3StorageConfig(s3_uri=s3_uri)
Expand DownExpand Up@@ -656,17 +664,17 @@ def update(
self,
feature_additions: Sequence[FeatureDefinition] = None,
online_store_config: OnlineStoreConfigUpdate = None,
throughput_config: ThroughputConfigUpdate = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup and add new features from the given feature definitions.

Args:
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (OnlineStoreConfigUpdate): online store config to be updated.

throughput_config (ThroughputConfigUpdate): target throughput configuration
Returns:
Response dict from service.
"""

if feature_additions is None:
feature_additions_parameter = None
else:
Expand All@@ -679,10 +687,15 @@ def update(
else:
online_store_config_parameter = online_store_config.to_dict()

throughput_config_parameter = (
None if throughput_config is None else throughput_config.to_dict()
)

return self.sagemaker_session.update_feature_group(
feature_group_name=self.name,
feature_additions=feature_additions_parameter,
online_store_config=online_store_config_parameter,
throughput_config=throughput_config_parameter,
)

def update_feature_metadata(
Expand Down
76 changes: 76 additions & 0 deletions src/sagemaker/feature_store/inputs.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -453,3 +453,79 @@ class ExpirationTimeResponseEnum(Enum):

DISABLED = "Disabled"
ENABLED = "Enabled"


class ThroughputModeEnum(Enum):
"""Enum of throughput modes supported by feature group.

Throughput mode of feature group can be ON_DEMAND or PROVISIONED.
"""

ON_DEMAND = "OnDemand"
PROVISIONED = "Provisioned"


@attr.s
class ThroughputConfig(Config):
"""Throughput configuration of the feature group.

Throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)


@attr.s
class ThroughputConfigUpdate(Config):
"""Target throughput configuration for the feature group.

Target throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Target throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)
28 changes: 18 additions & 10 deletions src/sagemaker/session.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -5679,6 +5679,7 @@ def create_feature_group(
role_arn: str = None,
online_store_config: Dict[str, str] = None,
offline_store_config: Dict[str, str] = None,
throughput_config: Dict[str, Any] = None,
description: str = None,
tags: Optional[Tags] = None,
) -> Dict[str, Any]:
Expand All@@ -5694,6 +5695,8 @@ def create_feature_group(
feature online store.
offline_store_config (Dict[str, str]): dict contains configuration of the
feature offline store.
throughput_config (Dict[str, str]): dict contains throughput configuration
for the feature group.
description (str): description of the FeatureGroup.
tags (Optional[Tags]): tags for labeling a FeatureGroup.

Expand DownExpand Up@@ -5729,6 +5732,7 @@ def create_feature_group(
kwargs,
OnlineStoreConfig=inferred_online_store_from_config,
OfflineStoreConfig=inferred_offline_store_from_config,
ThroughputConfig=throughput_config,
Description=description,
Tags=tags,
)
Expand DownExpand Up@@ -5757,28 +5761,32 @@ def update_feature_group(
feature_group_name: str,
feature_additions: Sequence[Dict[str, str]] = None,
online_store_config: Dict[str, any] = None,
throughput_config: Dict[str, Any] = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup

either adding new features from the given feature definitions
or updating online store config
Supports modifications like adding new features from the given feature definitions,
updating online store and throughput configurations.

Args:
feature_group_name (str): name of the FeatureGroup to update.
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (Dict[str, Any]): updates to online store config
throughput_config (Dict[str, Any]): target throughput configuration of the feature group
Returns:
Response dict from service.
"""
update_req = {"FeatureGroupName": feature_group_name}
if online_store_config is not None:
update_req["OnlineStoreConfig"] = online_store_config

if feature_additions is None:
return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name,
OnlineStoreConfig=online_store_config,
)
if throughput_config is not None:
update_req["ThroughputConfig"] = throughput_config

return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name, FeatureAdditions=feature_additions
)
if feature_additions is not None:
update_req["FeatureAdditions"] = feature_additions

return self.sagemaker_client.update_feature_group(**update_req)

def list_feature_groups(
self,
Expand Down
75 changes: 75 additions & 0 deletions tests/integ/test_feature_store.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,9 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputModeEnum,
ThroughputConfigUpdate,
)
from sagemaker.feature_store.dataset_builder import (
JoinTypeEnum,
Expand DownExpand Up@@ -410,6 +413,78 @@ def test_create_feature_group_standard_storage_type(
assert storage_type == "Standard"


def test_throughput_create_as_provisioned_and_update_to_ondemand(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.PROVISIONED, 4000, 4000),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 4000
assert wcu == 4000

feature_group.update(throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.ON_DEMAND))
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value


def test_throughput_create_as_ondemand_and_update_to_provisioned(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.ON_DEMAND),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value

feature_group.update(
throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.PROVISIONED, 100, 200)
)
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 100
assert wcu == 200


def test_ttl_duration(
feature_store_session,
role,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
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
12 changes: 12 additions & 0 deletions doc/api/prep_data/feature_store.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,6 +75,14 @@ Inputs
:members:
:show-inheritance:

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

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

.. autoclass:: sagemaker.feature_store.inputs.OnlineStoreConfig
:members:
:show-inheritance:
Expand All@@ -99,6 +107,10 @@ Inputs
:members:
:show-inheritance:

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

.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
:members:
:show-inheritance:
Expand Down
17 changes: 15 additions & 2 deletions src/sagemaker/feature_store/feature_group.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputConfigUpdate,
)
from sagemaker.utils import resolve_value_from_config, format_tags, Tags

Expand DownExpand Up@@ -541,6 +543,7 @@ def create(
tags: Optional[Tags] = None,
table_format: TableFormatEnum = None,
online_store_storage_type: OnlineStoreStorageTypeEnum = None,
throughput_config: ThroughputConfig = None,
) -> Dict[str, Any]:
"""Create a SageMaker FeatureStore FeatureGroup.

Expand DownExpand Up@@ -570,6 +573,8 @@ def create(
table_format (TableFormatEnum): format of the offline store table (default: None).
online_store_storage_type (OnlineStoreStorageTypeEnum): storage type for the
online store (default: None).
throughput_config (ThroughputConfig): throughput configuration of the
feature group (default: None).

Returns:
Response dict from service.
Expand DownExpand Up@@ -618,6 +623,9 @@ def create(
)
create_feature_store_args.update({"online_store_config": online_store_config.to_dict()})

if throughput_config:
create_feature_store_args.update({"throughput_config": throughput_config.to_dict()})

# offline store configuration
if s3_uri:
s3_storage_config = S3StorageConfig(s3_uri=s3_uri)
Expand DownExpand Up@@ -656,17 +664,17 @@ def update(
self,
feature_additions: Sequence[FeatureDefinition] = None,
online_store_config: OnlineStoreConfigUpdate = None,
throughput_config: ThroughputConfigUpdate = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup and add new features from the given feature definitions.

Args:
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (OnlineStoreConfigUpdate): online store config to be updated.

throughput_config (ThroughputConfigUpdate): target throughput configuration
Returns:
Response dict from service.
"""

if feature_additions is None:
feature_additions_parameter = None
else:
Expand All@@ -679,10 +687,15 @@ def update(
else:
online_store_config_parameter = online_store_config.to_dict()

throughput_config_parameter = (
None if throughput_config is None else throughput_config.to_dict()
)

return self.sagemaker_session.update_feature_group(
feature_group_name=self.name,
feature_additions=feature_additions_parameter,
online_store_config=online_store_config_parameter,
throughput_config=throughput_config_parameter,
)

def update_feature_metadata(
Expand Down
76 changes: 76 additions & 0 deletions src/sagemaker/feature_store/inputs.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -453,3 +453,79 @@ class ExpirationTimeResponseEnum(Enum):

DISABLED = "Disabled"
ENABLED = "Enabled"


class ThroughputModeEnum(Enum):
"""Enum of throughput modes supported by feature group.

Throughput mode of feature group can be ON_DEMAND or PROVISIONED.
"""

ON_DEMAND = "OnDemand"
PROVISIONED = "Provisioned"


@attr.s
class ThroughputConfig(Config):
"""Throughput configuration of the feature group.

Throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)


@attr.s
class ThroughputConfigUpdate(Config):
"""Target throughput configuration for the feature group.

Target throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Target throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)
28 changes: 18 additions & 10 deletions src/sagemaker/session.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -5679,6 +5679,7 @@ def create_feature_group(
role_arn: str = None,
online_store_config: Dict[str, str] = None,
offline_store_config: Dict[str, str] = None,
throughput_config: Dict[str, Any] = None,
description: str = None,
tags: Optional[Tags] = None,
) -> Dict[str, Any]:
Expand All@@ -5694,6 +5695,8 @@ def create_feature_group(
feature online store.
offline_store_config (Dict[str, str]): dict contains configuration of the
feature offline store.
throughput_config (Dict[str, str]): dict contains throughput configuration
for the feature group.
description (str): description of the FeatureGroup.
tags (Optional[Tags]): tags for labeling a FeatureGroup.

Expand DownExpand Up@@ -5729,6 +5732,7 @@ def create_feature_group(
kwargs,
OnlineStoreConfig=inferred_online_store_from_config,
OfflineStoreConfig=inferred_offline_store_from_config,
ThroughputConfig=throughput_config,
Description=description,
Tags=tags,
)
Expand DownExpand Up@@ -5757,28 +5761,32 @@ def update_feature_group(
feature_group_name: str,
feature_additions: Sequence[Dict[str, str]] = None,
online_store_config: Dict[str, any] = None,
throughput_config: Dict[str, Any] = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup

either adding new features from the given feature definitions
or updating online store config
Supports modifications like adding new features from the given feature definitions,
updating online store and throughput configurations.

Args:
feature_group_name (str): name of the FeatureGroup to update.
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (Dict[str, Any]): updates to online store config
throughput_config (Dict[str, Any]): target throughput configuration of the feature group
Returns:
Response dict from service.
"""
update_req = {"FeatureGroupName": feature_group_name}
if online_store_config is not None:
update_req["OnlineStoreConfig"] = online_store_config

if feature_additions is None:
return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name,
OnlineStoreConfig=online_store_config,
)
if throughput_config is not None:
update_req["ThroughputConfig"] = throughput_config

return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name, FeatureAdditions=feature_additions
)
if feature_additions is not None:
update_req["FeatureAdditions"] = feature_additions

return self.sagemaker_client.update_feature_group(**update_req)

def list_feature_groups(
self,
Expand Down
75 changes: 75 additions & 0 deletions tests/integ/test_feature_store.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,9 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputModeEnum,
ThroughputConfigUpdate,
)
from sagemaker.feature_store.dataset_builder import (
JoinTypeEnum,
Expand DownExpand Up@@ -410,6 +413,78 @@ def test_create_feature_group_standard_storage_type(
assert storage_type == "Standard"


def test_throughput_create_as_provisioned_and_update_to_ondemand(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.PROVISIONED, 4000, 4000),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 4000
assert wcu == 4000

feature_group.update(throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.ON_DEMAND))
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value


def test_throughput_create_as_ondemand_and_update_to_provisioned(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.ON_DEMAND),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value

feature_group.update(
throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.PROVISIONED, 100, 200)
)
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 100
assert wcu == 200


def test_ttl_duration(
feature_store_session,
role,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
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
12 changes: 12 additions & 0 deletions doc/api/prep_data/feature_store.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,6 +75,14 @@ Inputs
:members:
:show-inheritance:

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

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

.. autoclass:: sagemaker.feature_store.inputs.OnlineStoreConfig
:members:
:show-inheritance:
Expand All@@ -99,6 +107,10 @@ Inputs
:members:
:show-inheritance:

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

.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
:members:
:show-inheritance:
Expand Down
17 changes: 15 additions & 2 deletions src/sagemaker/feature_store/feature_group.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputConfigUpdate,
)
from sagemaker.utils import resolve_value_from_config, format_tags, Tags

Expand DownExpand Up@@ -541,6 +543,7 @@ def create(
tags: Optional[Tags] = None,
table_format: TableFormatEnum = None,
online_store_storage_type: OnlineStoreStorageTypeEnum = None,
throughput_config: ThroughputConfig = None,
) -> Dict[str, Any]:
"""Create a SageMaker FeatureStore FeatureGroup.

Expand DownExpand Up@@ -570,6 +573,8 @@ def create(
table_format (TableFormatEnum): format of the offline store table (default: None).
online_store_storage_type (OnlineStoreStorageTypeEnum): storage type for the
online store (default: None).
throughput_config (ThroughputConfig): throughput configuration of the
feature group (default: None).

Returns:
Response dict from service.
Expand DownExpand Up@@ -618,6 +623,9 @@ def create(
)
create_feature_store_args.update({"online_store_config": online_store_config.to_dict()})

if throughput_config:
create_feature_store_args.update({"throughput_config": throughput_config.to_dict()})

# offline store configuration
if s3_uri:
s3_storage_config = S3StorageConfig(s3_uri=s3_uri)
Expand DownExpand Up@@ -656,17 +664,17 @@ def update(
self,
feature_additions: Sequence[FeatureDefinition] = None,
online_store_config: OnlineStoreConfigUpdate = None,
throughput_config: ThroughputConfigUpdate = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup and add new features from the given feature definitions.

Args:
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (OnlineStoreConfigUpdate): online store config to be updated.

throughput_config (ThroughputConfigUpdate): target throughput configuration
Returns:
Response dict from service.
"""

if feature_additions is None:
feature_additions_parameter = None
else:
Expand All@@ -679,10 +687,15 @@ def update(
else:
online_store_config_parameter = online_store_config.to_dict()

throughput_config_parameter = (
None if throughput_config is None else throughput_config.to_dict()
)

return self.sagemaker_session.update_feature_group(
feature_group_name=self.name,
feature_additions=feature_additions_parameter,
online_store_config=online_store_config_parameter,
throughput_config=throughput_config_parameter,
)

def update_feature_metadata(
Expand Down
76 changes: 76 additions & 0 deletions src/sagemaker/feature_store/inputs.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -453,3 +453,79 @@ class ExpirationTimeResponseEnum(Enum):

DISABLED = "Disabled"
ENABLED = "Enabled"


class ThroughputModeEnum(Enum):
"""Enum of throughput modes supported by feature group.

Throughput mode of feature group can be ON_DEMAND or PROVISIONED.
"""

ON_DEMAND = "OnDemand"
PROVISIONED = "Provisioned"


@attr.s
class ThroughputConfig(Config):
"""Throughput configuration of the feature group.

Throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)


@attr.s
class ThroughputConfigUpdate(Config):
"""Target throughput configuration for the feature group.

Target throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Target throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)
28 changes: 18 additions & 10 deletions src/sagemaker/session.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -5679,6 +5679,7 @@ def create_feature_group(
role_arn: str = None,
online_store_config: Dict[str, str] = None,
offline_store_config: Dict[str, str] = None,
throughput_config: Dict[str, Any] = None,
description: str = None,
tags: Optional[Tags] = None,
) -> Dict[str, Any]:
Expand All@@ -5694,6 +5695,8 @@ def create_feature_group(
feature online store.
offline_store_config (Dict[str, str]): dict contains configuration of the
feature offline store.
throughput_config (Dict[str, str]): dict contains throughput configuration
for the feature group.
description (str): description of the FeatureGroup.
tags (Optional[Tags]): tags for labeling a FeatureGroup.

Expand DownExpand Up@@ -5729,6 +5732,7 @@ def create_feature_group(
kwargs,
OnlineStoreConfig=inferred_online_store_from_config,
OfflineStoreConfig=inferred_offline_store_from_config,
ThroughputConfig=throughput_config,
Description=description,
Tags=tags,
)
Expand DownExpand Up@@ -5757,28 +5761,32 @@ def update_feature_group(
feature_group_name: str,
feature_additions: Sequence[Dict[str, str]] = None,
online_store_config: Dict[str, any] = None,
throughput_config: Dict[str, Any] = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup

either adding new features from the given feature definitions
or updating online store config
Supports modifications like adding new features from the given feature definitions,
updating online store and throughput configurations.

Args:
feature_group_name (str): name of the FeatureGroup to update.
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (Dict[str, Any]): updates to online store config
throughput_config (Dict[str, Any]): target throughput configuration of the feature group
Returns:
Response dict from service.
"""
update_req = {"FeatureGroupName": feature_group_name}
if online_store_config is not None:
update_req["OnlineStoreConfig"] = online_store_config

if feature_additions is None:
return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name,
OnlineStoreConfig=online_store_config,
)
if throughput_config is not None:
update_req["ThroughputConfig"] = throughput_config

return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name, FeatureAdditions=feature_additions
)
if feature_additions is not None:
update_req["FeatureAdditions"] = feature_additions

return self.sagemaker_client.update_feature_group(**update_req)

def list_feature_groups(
self,
Expand Down
75 changes: 75 additions & 0 deletions tests/integ/test_feature_store.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,9 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputModeEnum,
ThroughputConfigUpdate,
)
from sagemaker.feature_store.dataset_builder import (
JoinTypeEnum,
Expand DownExpand Up@@ -410,6 +413,78 @@ def test_create_feature_group_standard_storage_type(
assert storage_type == "Standard"


def test_throughput_create_as_provisioned_and_update_to_ondemand(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.PROVISIONED, 4000, 4000),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 4000
assert wcu == 4000

feature_group.update(throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.ON_DEMAND))
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value


def test_throughput_create_as_ondemand_and_update_to_provisioned(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.ON_DEMAND),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value

feature_group.update(
throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.PROVISIONED, 100, 200)
)
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 100
assert wcu == 200


def test_ttl_duration(
feature_store_session,
role,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
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
12 changes: 12 additions & 0 deletions doc/api/prep_data/feature_store.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,6 +75,14 @@ Inputs
:members:
:show-inheritance:

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

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

.. autoclass:: sagemaker.feature_store.inputs.OnlineStoreConfig
:members:
:show-inheritance:
Expand All@@ -99,6 +107,10 @@ Inputs
:members:
:show-inheritance:

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

.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
:members:
:show-inheritance:
Expand Down
17 changes: 15 additions & 2 deletions src/sagemaker/feature_store/feature_group.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputConfigUpdate,
)
from sagemaker.utils import resolve_value_from_config, format_tags, Tags

Expand DownExpand Up@@ -541,6 +543,7 @@ def create(
tags: Optional[Tags] = None,
table_format: TableFormatEnum = None,
online_store_storage_type: OnlineStoreStorageTypeEnum = None,
throughput_config: ThroughputConfig = None,
) -> Dict[str, Any]:
"""Create a SageMaker FeatureStore FeatureGroup.

Expand DownExpand Up@@ -570,6 +573,8 @@ def create(
table_format (TableFormatEnum): format of the offline store table (default: None).
online_store_storage_type (OnlineStoreStorageTypeEnum): storage type for the
online store (default: None).
throughput_config (ThroughputConfig): throughput configuration of the
feature group (default: None).

Returns:
Response dict from service.
Expand DownExpand Up@@ -618,6 +623,9 @@ def create(
)
create_feature_store_args.update({"online_store_config": online_store_config.to_dict()})

if throughput_config:
create_feature_store_args.update({"throughput_config": throughput_config.to_dict()})

# offline store configuration
if s3_uri:
s3_storage_config = S3StorageConfig(s3_uri=s3_uri)
Expand DownExpand Up@@ -656,17 +664,17 @@ def update(
self,
feature_additions: Sequence[FeatureDefinition] = None,
online_store_config: OnlineStoreConfigUpdate = None,
throughput_config: ThroughputConfigUpdate = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup and add new features from the given feature definitions.

Args:
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (OnlineStoreConfigUpdate): online store config to be updated.

throughput_config (ThroughputConfigUpdate): target throughput configuration
Returns:
Response dict from service.
"""

if feature_additions is None:
feature_additions_parameter = None
else:
Expand All@@ -679,10 +687,15 @@ def update(
else:
online_store_config_parameter = online_store_config.to_dict()

throughput_config_parameter = (
None if throughput_config is None else throughput_config.to_dict()
)

return self.sagemaker_session.update_feature_group(
feature_group_name=self.name,
feature_additions=feature_additions_parameter,
online_store_config=online_store_config_parameter,
throughput_config=throughput_config_parameter,
)

def update_feature_metadata(
Expand Down
76 changes: 76 additions & 0 deletions src/sagemaker/feature_store/inputs.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -453,3 +453,79 @@ class ExpirationTimeResponseEnum(Enum):

DISABLED = "Disabled"
ENABLED = "Enabled"


class ThroughputModeEnum(Enum):
"""Enum of throughput modes supported by feature group.

Throughput mode of feature group can be ON_DEMAND or PROVISIONED.
"""

ON_DEMAND = "OnDemand"
PROVISIONED = "Provisioned"


@attr.s
class ThroughputConfig(Config):
"""Throughput configuration of the feature group.

Throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)


@attr.s
class ThroughputConfigUpdate(Config):
"""Target throughput configuration for the feature group.

Target throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
read and write capacity units. ON_DEMAND works best for less predictable traffic,
while PROVISIONED works best for consistent and predictable traffic.

Attributes:
mode (ThroughputModeEnum): Target throughput mode
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
the read throughput you are billed for and can consume without throttling.
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
the write throughput you are billed for and can consume without throttling.
"""

mode: ThroughputModeEnum = attr.ib(default=None)
provisioned_read_capacity_units: int = attr.ib(default=None)
provisioned_write_capacity_units: int = attr.ib(default=None)

def to_dict(self) -> Dict[str, Any]:
"""Construct a dictionary based on the attributes provided.

Returns:
dict represents the attributes.
"""
return Config.construct_dict(
ThroughputMode=self.mode.value if self.mode else None,
ProvisionedReadCapacityUnits=self.provisioned_read_capacity_units,
ProvisionedWriteCapacityUnits=self.provisioned_write_capacity_units,
)
28 changes: 18 additions & 10 deletions src/sagemaker/session.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -5679,6 +5679,7 @@ def create_feature_group(
role_arn: str = None,
online_store_config: Dict[str, str] = None,
offline_store_config: Dict[str, str] = None,
throughput_config: Dict[str, Any] = None,
description: str = None,
tags: Optional[Tags] = None,
) -> Dict[str, Any]:
Expand All@@ -5694,6 +5695,8 @@ def create_feature_group(
feature online store.
offline_store_config (Dict[str, str]): dict contains configuration of the
feature offline store.
throughput_config (Dict[str, str]): dict contains throughput configuration
for the feature group.
description (str): description of the FeatureGroup.
tags (Optional[Tags]): tags for labeling a FeatureGroup.

Expand DownExpand Up@@ -5729,6 +5732,7 @@ def create_feature_group(
kwargs,
OnlineStoreConfig=inferred_online_store_from_config,
OfflineStoreConfig=inferred_offline_store_from_config,
ThroughputConfig=throughput_config,
Description=description,
Tags=tags,
)
Expand DownExpand Up@@ -5757,28 +5761,32 @@ def update_feature_group(
feature_group_name: str,
feature_additions: Sequence[Dict[str, str]] = None,
online_store_config: Dict[str, any] = None,
throughput_config: Dict[str, Any] = None,
) -> Dict[str, Any]:
"""Update a FeatureGroup

either adding new features from the given feature definitions
or updating online store config
Supports modifications like adding new features from the given feature definitions,
updating online store and throughput configurations.

Args:
feature_group_name (str): name of the FeatureGroup to update.
feature_additions (Sequence[Dict[str, str]): list of feature definitions to be updated.
online_store_config (Dict[str, Any]): updates to online store config
throughput_config (Dict[str, Any]): target throughput configuration of the feature group
Returns:
Response dict from service.
"""
update_req = {"FeatureGroupName": feature_group_name}
if online_store_config is not None:
update_req["OnlineStoreConfig"] = online_store_config

if feature_additions is None:
return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name,
OnlineStoreConfig=online_store_config,
)
if throughput_config is not None:
update_req["ThroughputConfig"] = throughput_config

return self.sagemaker_client.update_feature_group(
FeatureGroupName=feature_group_name, FeatureAdditions=feature_additions
)
if feature_additions is not None:
update_req["FeatureAdditions"] = feature_additions

return self.sagemaker_client.update_feature_group(**update_req)

def list_feature_groups(
self,
Expand Down
75 changes: 75 additions & 0 deletions tests/integ/test_feature_store.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,9 @@
TtlDuration,
OnlineStoreConfigUpdate,
OnlineStoreStorageTypeEnum,
ThroughputConfig,
ThroughputModeEnum,
ThroughputConfigUpdate,
)
from sagemaker.feature_store.dataset_builder import (
JoinTypeEnum,
Expand DownExpand Up@@ -410,6 +413,78 @@ def test_create_feature_group_standard_storage_type(
assert storage_type == "Standard"


def test_throughput_create_as_provisioned_and_update_to_ondemand(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.PROVISIONED, 4000, 4000),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 4000
assert wcu == 4000

feature_group.update(throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.ON_DEMAND))
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value


def test_throughput_create_as_ondemand_and_update_to_provisioned(
feature_store_session,
role,
feature_group_name,
pandas_data_frame,
):
feature_group = FeatureGroup(name=feature_group_name, sagemaker_session=feature_store_session)
feature_group.load_feature_definitions(data_frame=pandas_data_frame)
with cleanup_feature_group(feature_group):
feature_group.create(
s3_uri=False,
record_identifier_name="feature1",
event_time_feature_name="feature3",
role_arn=role,
enable_online_store=True,
throughput_config=ThroughputConfig(ThroughputModeEnum.ON_DEMAND),
)
_wait_for_feature_group_create(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
assert mode == ThroughputModeEnum.ON_DEMAND.value

feature_group.update(
throughput_config=ThroughputConfigUpdate(ThroughputModeEnum.PROVISIONED, 100, 200)
)
_wait_for_feature_group_update(feature_group)

tp_config = feature_group.describe().get("ThroughputConfig")
mode = tp_config.get("ThroughputMode")
rcu = tp_config.get("ProvisionedReadCapacityUnits")
wcu = tp_config.get("ProvisionedWriteCapacityUnits")
assert mode == ThroughputModeEnum.PROVISIONED.value
assert rcu == 100
assert wcu == 200


def test_ttl_duration(
feature_store_session,
role,
Expand Down
Loading