Skip to content

Commit fa79418

Browse files
caxiaohuknakad
authored andcommitted
doc: changed EFS directory path instructions in documentation and Docstrings (#996)
1 parent a73e4ae commit fa79418

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

doc/overview.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ Here are examples of how to use Amazon EFS as input for training:
327327
328328
file_system_input = FileSystemInput(file_system_id='fs-1',
329329
file_system_type='EFS',
330-
directory_path='tensorflow',
330+
directory_path='/tensorflow',
331331
file_system_access_mode='ro')
332332
333333
# Start an Amazon SageMaker training job with EFS using the FileSystemInput class
@@ -347,7 +347,7 @@ Here are examples of how to use Amazon EFS as input for training:
347347
348348
records = FileSystemRecordSet(file_system_id='fs-1,
349349
file_system_type='EFS',
350-
directory_path='kmeans',
350+
directory_path='/kmeans',
351351
num_records=784,
352352
feature_dim=784)
353353
@@ -372,7 +372,7 @@ Here are examples of how to use Amazon FSx for Lustre as input for training:
372372
373373
file_system_input = FileSystemInput(file_system_id='fs-2',
374374
file_system_type='FSxLustre',
375-
directory_path='tensorflow',
375+
directory_path='/fsx/tensorflow',
376376
file_system_access_mode='ro')
377377
378378
# Start an Amazon SageMaker training job with FSx using the FileSystemInput class
@@ -392,7 +392,7 @@ Here are examples of how to use Amazon FSx for Lustre as input for training:
392392
393393
records = FileSystemRecordSet(file_system_id='fs-=2,
394394
file_system_type='FSxLustre',
395-
directory_path='kmeans',
395+
directory_path='/fsx/kmeans',
396396
num_records=784,
397397
feature_dim=784)
398398

src/sagemaker/amazon/amazon_estimator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ def __init__(
303303
file_system_id (str): An Amazon file system ID starting with 'fs-'.
304304
file_system_type (str): The type of file system used for the input.
305305
Valid values: 'EFS', 'FSxLustre'.
306-
directory_path (str): Relative path to the root directory (mount point) in
306+
directory_path (str): Absolute or normalized path to the root directory (mount point) in
307307
the file system. Reference:
308308
https://docs.aws.amazon.com/efs/latest/ug/mounting-fs.html and
309309
https://docs.aws.amazon.com/efs/latest/ug/wt1-test.html

src/sagemaker/inputs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ def __init__(
114114
file_system_id (str): An Amazon file system ID starting with 'fs-'.
115115
file_system_type (str): The type of file system used for the input.
116116
Valid values: 'EFS', 'FSxLustre'.
117-
directory_path (str): Relative path to the root directory (mount point) in
117+
directory_path (str): Absolute or normalized path to the root directory (mount point) in
118118
the file system.
119119
Reference: https://docs.aws.amazon.com/efs/latest/ug/mounting-fs.html and
120120
https://docs.aws.amazon.com/fsx/latest/LustreGuide/mount-fs-auto-mount-onreboot.html

0 commit comments

Comments
 (0)