Skip to content

Commit b0ea062

Browse files
Nilesh PSknikure
authored andcommitted
documentation: add doc for feature group throughput config
1 parent 3b3d661 commit b0ea062

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

doc/api/prep_data/feature_store.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,14 @@ Inputs
7575
:members:
7676
:show-inheritance:
7777

78+
.. autoclass:: sagemaker.feature_store.inputs.ThroughputConfig
79+
:members:
80+
:show-inheritance:
81+
82+
.. autoclass:: sagemaker.feature_store.inputs.ThroughputConfigUpdate
83+
:members:
84+
:show-inheritance:
85+
7886
.. autoclass:: sagemaker.feature_store.inputs.OnlineStoreConfig
7987
:members:
8088
:show-inheritance:
@@ -99,6 +107,10 @@ Inputs
99107
:members:
100108
:show-inheritance:
101109

110+
.. autoclass:: sagemaker.feature_store.inputs.ThroughputModeEnum
111+
:members:
112+
:show-inheritance:
113+
102114
.. autoclass:: sagemaker.feature_store.inputs.ResourceEnum
103115
:members:
104116
:show-inheritance:

src/sagemaker/feature_store/inputs.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,13 @@ class ThroughputConfig(Config):
472472
Throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
473473
read and write capacity units. ON_DEMAND works best for less predictable traffic,
474474
while PROVISIONED works best for consistent and predictable traffic.
475+
476+
Attributes:
477+
mode (ThroughputModeEnum): Throughput mode
478+
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
479+
the read throughput you are billed for and can consume without throttling.
480+
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
481+
the write throughput you are billed for and can consume without throttling.
475482
"""
476483

477484
mode: ThroughputModeEnum = attr.ib(default=None)
@@ -493,11 +500,18 @@ def to_dict(self) -> Dict[str, Any]:
493500

494501
@attr.s
495502
class ThroughputConfigUpdate(Config):
496-
"""Target throughput configuration of the feature group being updated.
503+
"""Target throughput configuration for the feature group.
497504
498505
Target throughput configuration can be ON_DEMAND, or PROVISIONED with valid values for
499506
read and write capacity units. ON_DEMAND works best for less predictable traffic,
500507
while PROVISIONED works best for consistent and predictable traffic.
508+
509+
Attributes:
510+
mode (ThroughputModeEnum): Target throughput mode
511+
provisioned_read_capacity_units (int): For provisioned feature groups, this indicates
512+
the read throughput you are billed for and can consume without throttling.
513+
provisioned_write_capacity_units (int): For provisioned feature groups, this indicates
514+
the write throughput you are billed for and can consume without throttling.
501515
"""
502516

503517
mode: ThroughputModeEnum = attr.ib(default=None)

0 commit comments

Comments
 (0)