Skip to content

Commit a7309e3

Browse files
fix: sphinx class reference
1 parent 11e2ee0 commit a7309e3

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

src/sagemaker/feature_group_utils.py

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131

3232
def _get_session_from_role(role: str, region: str) -> Session:
33-
"""Method use to get the :class:~`sagemaker.session.Session` from a role and a region.
33+
"""Method use to get the ":class:~`sagemaker.session.Session`" from a role and a region.
3434
3535
Helpful in case it's invoke from a session with a role without permission it can assume
3636
another role temporarily to perform certain taks.
@@ -89,8 +89,7 @@ def get_feature_group_as_dataframe(
8989
verbose: bool = True,
9090
**pandas_read_csv_kwargs,
9191
) -> DataFrame:
92-
"""Get a :class:~`sagemaker.feature_store.feature_group.FeatureGroup`
93-
as a pandas.DataFrame
92+
"""Get a ":class:~`sagemaker.feature_store.feature_group.FeatureGroup`" as a pandas.DataFrame
9493
9594
Description:
9695
Method to run an athena query over a Feature Group in a Feature Store
@@ -108,7 +107,7 @@ def get_feature_group_as_dataframe(
108107
'SELECT * FROM "sagemaker_featurestore"."#{table}"'
109108
athena_bucket (str): Amazon S3 bucket for running the query
110109
role (str): role of the account used to extract data from feature store
111-
session (str): :class:~`sagemaker.session.Session`
110+
session (str): ":class:"~`sagemaker.session.Session`"
112111
of SageMaker used to work with the feature store
113112
event_time_feature_name (str): eventTimeId feature. Mandatory only if the
114113
latest ingestion is True
@@ -175,8 +174,7 @@ def get_feature_group_as_dataframe(
175174

176175

177176
def _format_column_names(data: pandas.DataFrame) -> pandas.DataFrame:
178-
"""Formats the column names in a valid way for
179-
:class:~`sagemaker.feature_store.feature_group.FeatureGroup`
177+
"""Formats the column names in a valid way for ":class:~`sagemaker.feature_store.feature_group.FeatureGroup`"
180178
181179
Module to format correctly the name of the columns of a DataFrame
182180
to later generate the features names of a Feature Group
@@ -220,7 +218,7 @@ def prepare_fg_from_dataframe_or_file(
220218
**pandas_read_csv_kwargs,
221219
) -> FeatureGroup:
222220
"""Module to prepare a dataframe before creating a
223-
:class:~`sagemaker.feature_store.feature_group.FeatureGroup`
221+
":class:"~`sagemaker.feature_store.feature_group.FeatureGroup`"
224222
225223
Function to prepare a dataframe for creating a Feature Group from a pandas.DataFrame
226224
or a path to a file with proper dtypes, feature names and mandatory features (record_id,
@@ -244,8 +242,8 @@ def prepare_fg_from_dataframe_or_file(
244242
session (str): session of SageMaker used to work with the feature store
245243
246244
Returns:
247-
:class:~`sagemaker.feature_store.feature_group.FeatureGroup`:
248-
FG prepared with all the methods and definitions properly defined
245+
":class:"~`sagemaker.feature_store.feature_group.FeatureGroup`": FG prepared with all
246+
the methods and definitions properly defined
249247
"""
250248

251249
logger.setLevel(logging.WARNING)

0 commit comments

Comments
 (0)