Skip to content

Commit a94a3b1

Browse files
authored
fix: Update feature_group.py ingest() description (#3615)
* Update feature_group.py ingest() description Updating ingest function description (https://sagemaker.readthedocs.io/en/stable/api/prep_data/feature_store.html#sagemaker.feature_store.feature_group.FeatureGroup.ingest) according to discussion in a thread (https://amzn-aws.slack.com/archives/C02FT61K4BV/p1661876115110819). * documentation: get rid of white spaces
1 parent 76d9c5a commit a94a3b1

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

src/sagemaker/feature_store/feature_group.py

+16-11
Original file line numberDiff line numberDiff line change
@@ -702,20 +702,25 @@ def ingest(
702702
) -> IngestionManagerPandas:
703703
"""Ingest the content of a pandas DataFrame to feature store.
704704
705-
``max_worker`` number of thread will be created to work on different partitions of
706-
the ``data_frame`` in parallel.
705+
``max_worker`` the number of threads created to work on different partitions of the
706+
``data_frame`` in parallel.
707707
708-
``max_processes`` number of processes will be created to work on different partitions
709-
of the ``data_frame`` in parallel, each with ``max_worker`` threads.
708+
``max_processes`` the number of processes will be created to work on different
709+
partitions of the ``data_frame`` in parallel, each with ``max_worker`` threads.
710710
711-
The ingest function will attempt to ingest all records in the data frame. If ``wait``
712-
is True, then an exception is thrown after all records have been processed. If ``wait``
713-
is False, then a later call to the returned instance IngestionManagerPandas' ``wait()``
714-
function will throw an exception.
711+
The ingest function attempts to ingest all records in the data frame. SageMaker
712+
Feature Store throws an exception if it fails to ingest any records.
715713
716-
Zero based indices of rows that failed to be ingested can be found in the exception.
717-
They can also be found from the IngestionManagerPandas' ``failed_rows`` function after
718-
the exception is thrown.
714+
If ``wait`` is ``True``, Feature Store runs the ``ingest`` function synchronously.
715+
You receive an ``IngestionError`` if there are any records that can't be ingested.
716+
If ``wait`` is ``False``, Feature Store runs the ``ingest`` function asynchronously.
717+
718+
Instead of setting ``wait`` to ``True`` in the ``ingest`` function, you can invoke
719+
the ``wait`` function on the returned instance of ``IngestionManagerPandas`` to run
720+
the ``ingest`` function synchronously.
721+
722+
To access the rows that failed to ingest, set ``wait`` to ``False``. The
723+
``IngestionError.failed_rows`` object saves all of the rows that failed to ingest.
719724
720725
`profile_name` argument is an optional one. It will use the default credential if None is
721726
passed. This `profile_name` is used in the sagemaker_featurestore_runtime client only. See

0 commit comments

Comments
 (0)