Skip to content

Commit 122f066

Browse files
committed
doc: made changes per feedback comments
1 parent 2fb1a12 commit 122f066

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

doc/overview.rst

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ There's also an ``Estimator`` that runs SageMaker compatible custom Docker conta
1919
Train a Model with the SageMaker Python SDK
2020
*******************************************
2121

22-
To train a model by using the SageMaker Pthon SDK, you:
22+
To train a model by using the SageMaker Python SDK, you:
2323

2424
1. Prepare a training script
2525
2. Create an estimator
26-
3. Call the `fit` method of the estimator
26+
3. Call the ``fit`` method of the estimator
2727

2828
After you train a model, you can save it, and then serve the model as an endpoint to get real-time inferences or get inferences for an entire dataset by using batch transform.
2929

@@ -277,6 +277,10 @@ Please refer to the full example in the examples repo:
277277
The example notebook is located here:
278278
``advanced_functionality/scikit_bring_your_own/scikit_bring_your_own.ipynb``
279279
280+
You can also find this notebook in the **Advanced Functionality** folder of the **SageMaker Examples** section in a notebook instance.
281+
For information about using sample notebooks in a SageMaker notebook instance, see `Use Example Notebooks <https://docs.aws.amazon.com/sagemaker/latest/dg/howitworks-nbexamples.html>`__
282+
in the AWS documentation.
283+
280284
Incremental Training
281285
====================
282286
@@ -375,6 +379,10 @@ This returns a predictor the same way an ``Estimator`` does when ``deploy()`` is
375379
376380
A full example is available in the `Amazon SageMaker examples repository <https://github.com/awslabs/amazon-sagemaker-examples/tree/master/advanced_functionality/mxnet_mnist_byom>`__.
377381
382+
You can also find this notebook in the **Advanced Functionality** section of the **SageMaker Examples** section in a notebook instance.
383+
For information about using sample notebooks in a SageMaker notebook instance, see `Use Example Notebooks <https://docs.aws.amazon.com/sagemaker/latest/dg/howitworks-nbexamples.html>`__
384+
in the AWS documentation.
385+
378386
Consuming SageMaker Model Packages
379387
==================================
380388
@@ -494,6 +502,10 @@ For more detailed examples of running hyperparameter tuning jobs, see:
494502
- `Bringing your own estimator for hyperparameter tuning <https://github.com/awslabs/amazon-sagemaker-examples/blob/master/hyperparameter_tuning/r_bring_your_own/hpo_r_bring_your_own.ipynb>`__
495503
- `Analyzing results <https://github.com/awslabs/amazon-sagemaker-examples/blob/master/hyperparameter_tuning/analyze_results/HPO_Analyze_TuningJob_Results.ipynb>`__
496504
505+
You can also find these notebooks in the **Hyperprameter Tuning** section of the **SageMaker Examples** section in a notebook instance.
506+
For information about using sample notebooks in a SageMaker notebook instance, see `Use Example Notebooks <https://docs.aws.amazon.com/sagemaker/latest/dg/howitworks-nbexamples.html>`__
507+
in the AWS documentation.
508+
497509
For more detailed explanations of the classes that this library provides for automatic model tuning, see:
498510
499511
- `API docs for HyperparameterTuner and parameter range classes <https://sagemaker.readthedocs.io/en/stable/tuner.html>`__
@@ -630,6 +642,10 @@ For detailed examples of running Docker in local mode, see:
630642
- `TensorFlow local mode example notebook <https://github.com/awslabs/amazon-sagemaker-examples/blob/master/sagemaker-python-sdk/tensorflow_distributed_mnist/tensorflow_local_mode_mnist.ipynb>`__.
631643
- `MXNet local mode example notebook <https://github.com/awslabs/amazon-sagemaker-examples/blob/master/sagemaker-python-sdk/mxnet_gluon_mnist/mnist_with_gluon_local_mode.ipynb>`__.
632644
645+
You can also find these notebooks in the **SageMaker Python SDK** section of the **SageMaker Examples** section in a notebook instance.
646+
For information about using sample notebooks in a SageMaker notebook instance, see `Use Example Notebooks <https://docs.aws.amazon.com/sagemaker/latest/dg/howitworks-nbexamples.html>`__
647+
in the AWS documentation.
648+
633649
A few important notes:
634650
635651
- Only one local mode endpoint can be running at a time.
@@ -830,6 +846,10 @@ This returns a predictor the same way an ``Estimator`` does when ``deploy()`` is
830846
831847
A full example is available in the `Amazon SageMaker examples repository <https://github.com/awslabs/amazon-sagemaker-examples/tree/master/advanced_functionality/mxnet_mnist_byom>`__.
832848
849+
You can also find this notebook in the **Advanced Functionality** section of the **SageMaker Examples** section in a notebook instance.
850+
For information about using sample notebooks in a SageMaker notebook instance, see `Use Example Notebooks <https://docs.aws.amazon.com/sagemaker/latest/dg/howitworks-nbexamples.html>`__
851+
in the AWS documentation.
852+
833853
834854
Inference Pipelines
835855
*******************
@@ -857,6 +877,10 @@ For more information about how to train an XGBoost model, please refer to the XG
857877
858878
.. _here: https://github.com/awslabs/amazon-sagemaker-examples/blob/master/introduction_to_amazon_algorithms/xgboost_abalone/xgboost_abalone.ipynb
859879
880+
You can also find this notebook in the **Introduction to Amazon Algorithms** section of the **SageMaker Examples** section in a notebook instance.
881+
For information about using sample notebooks in a SageMaker notebook instance, see `Use Example Notebooks <https://docs.aws.amazon.com/sagemaker/latest/dg/howitworks-nbexamples.html>`__
882+
in the AWS documentation.
883+
860884
.. code:: python
861885
862886
sm_model.deploy(initial_instance_count=1, instance_type='ml.c5.xlarge', endpoint_name=endpoint_name)
@@ -899,6 +923,10 @@ For comprehensive examples on how to use Inference Pipelines please refer to the
899923
- `inference_pipeline_sparkml_xgboost_abalone.ipynb <https://github.com/awslabs/amazon-sagemaker-examples/blob/master/advanced_functionality/inference_pipeline_sparkml_xgboost_abalone/inference_pipeline_sparkml_xgboost_abalone.ipynb>`__
900924
- `inference_pipeline_sparkml_blazingtext_dbpedia.ipynb <https://github.com/awslabs/amazon-sagemaker-examples/blob/master/advanced_functionality/inference_pipeline_sparkml_blazingtext_dbpedia/inference_pipeline_sparkml_blazingtext_dbpedia.ipynb>`__
901925
926+
You can also find these notebooks in the **Advanced Functionality** section of the **SageMaker Examples** section in a notebook instance.
927+
For information about using sample notebooks in a SageMaker notebook instance, see `Use Example Notebooks <https://docs.aws.amazon.com/sagemaker/latest/dg/howitworks-nbexamples.html>`__
928+
in the AWS documentation.
929+
902930
******************
903931
SageMaker Workflow
904932
******************

0 commit comments

Comments
 (0)