Skip to content

Commit 7f53751

Browse files
ajberdyahsan-z-khanjeniyat
authored andcommitted
documentation: fix documentation for input types in estimator.fit (aws#2685)
* documentation: fix documentation for input types in estimator.fit * documentation: add fourth input type to type list for inputs in doc string * update type options for values in dict input Co-authored-by: Ahsan Khan <[email protected]> Co-authored-by: Jeniya Tabassum <[email protected]>
1 parent 7d24584 commit 7f53751

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

src/sagemaker/estimator.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -650,19 +650,22 @@ def fit(self, inputs=None, wait=True, logs="All", job_name=None, experiment_conf
650650
model using the Amazon SageMaker hosting services.
651651
652652
Args:
653-
inputs (str or dict or sagemaker.inputs.TrainingInput): Information
654-
about the training data. This can be one of three types:
653+
inputs (str or dict or sagemaker.inputs.TrainingInput or
654+
sagemaker.inputs.FileSystemInput): Information about the training data.
655+
This can be one of four types:
655656
656657
* (str) the S3 location where training data is saved, or a file:// path in
657658
local mode.
658-
* (dict[str, str] or dict[str, sagemaker.inputs.TrainingInput]) If using multiple
659-
channels for training data, you can specify a dict mapping channel names to
660-
strings or :func:`~sagemaker.inputs.TrainingInput` objects.
659+
* (dict[str, str] or dict[str, sagemaker.inputs.TrainingInput] or
660+
dict[str, sagemaker.inputs.FileSystemInput]) If using multiple channels for
661+
training data, you can specify a dict mapping channel names to strings or
662+
:func:`~sagemaker.inputs.TrainingInput` objects or
663+
:func:`~sagemaker.inputs.FileSystemInput` objects.
661664
* (sagemaker.inputs.TrainingInput) - channel configuration for S3 data sources
662665
that can provide additional information as well as the path to the training
663666
dataset.
664667
See :func:`sagemaker.inputs.TrainingInput` for full details.
665-
* (sagemaker.session.FileSystemInput) - channel configuration for
668+
* (sagemaker.inputs.FileSystemInput) - channel configuration for
666669
a file system data source that can provide additional information as well as
667670
the path to the training dataset.
668671

0 commit comments

Comments
 (0)