Skip to content

Commit 0faec72

Browse files
nmadanNamrata Madan
authored andcommitted
doc: CustomFileFilter doc updates (#1318)
Co-authored-by: Namrata Madan <[email protected]>
1 parent 447e531 commit 0faec72

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

doc/remote_function/sagemaker.remote_function.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,10 @@ Future
2424
.. automethod:: sagemaker.remote_function.client.list_futures
2525

2626
.. automethod:: sagemaker.remote_function.client.get_future
27+
28+
29+
CustomFileFilter
30+
----------------
31+
32+
.. autoclass:: sagemaker.remote_function.custom_file_filter.CustomFileFilter
33+

src/sagemaker/remote_function/client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,8 @@ def remote(
197197
custom_file_filter (Callable[[str, List], List], CustomFileFilter): Either a function
198198
that filters job dependencies to be uploaded to S3 or a ``CustomFileFilter`` object
199199
that specifies the local directories and files to be included in the remote function.
200-
If a callable is passed in, that function is passed to the ``ignore`` argument of
201-
``shutil.copytree``. Defaults to ``None``, which means only python
200+
If a callable is passed in, the function should follow the protocol of ``ignore`` argument
201+
of ``shutil.copytree``. Defaults to ``None``, which means only python
202202
files are accepted and uploaded to S3.
203203
204204
instance_count (int): The number of instances to use. Defaults to 1.

0 commit comments

Comments
 (0)