Skip to content

Commit a3a927b

Browse files
Danlaurenyu
authored andcommitted
documentation: mention that the entry_point needs to be named inference.py for tfs (#1153)
1 parent 60d5a4d commit a3a927b

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

doc/using_tf.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -723,7 +723,8 @@ JSON options instead.
723723
Create Python Scripts for Custom Input and Output Formats
724724
---------------------------------------------------------
725725
726-
You can add your customized Python code to process your input and output data:
726+
You can add your customized Python code to process your input and output data.
727+
This customized Python code must be named ``inference.py`` and specified through the ``entry_point`` parameter:
727728
728729
.. code::
729730
@@ -736,8 +737,9 @@ You can add your customized Python code to process your input and output data:
736737
How to implement the pre- and/or post-processing handler(s)
737738
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
738739
739-
Your entry point file should implement either a pair of ``input_handler``
740-
and ``output_handler`` functions or a single ``handler`` function.
740+
Your entry point file must be named ``inference.py`` and should implement
741+
either a pair of ``input_handler`` and ``output_handler`` functions or
742+
a single ``handler`` function.
741743
Note that if ``handler`` function is implemented, ``input_handler``
742744
and ``output_handler`` are ignored.
743745
@@ -905,6 +907,7 @@ processing. There are 2 ways to do this:
905907
model_data='s3://mybucket/model.tar.gz',
906908
role='MySageMakerRole')
907909
910+
For more information, see: https://github.com/aws/sagemaker-tensorflow-serving-container#prepost-processing
908911
909912
*************************************
910913
sagemaker.tensorflow.TensorFlow Class

src/sagemaker/tensorflow/deploying_tensorflow_serving.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,8 @@ inference-time behavior of your SavedModels.
272272
Providing Python scripts for pre/pos-processing
273273
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
274274

275-
You can add your customized Python code to process your input and output data:
275+
You can add your customized Python code to process your input and output data.
276+
This customized Python code must be named ``inference.py`` and specified through the ``entry_point`` parameter:
276277

277278
.. code::
278279
@@ -285,8 +286,9 @@ You can add your customized Python code to process your input and output data:
285286
How to implement the pre- and/or post-processing handler(s)
286287
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
287288

288-
Your entry point file should implement either a pair of ``input_handler``
289-
and ``output_handler`` functions or a single ``handler`` function.
289+
Your entry point file must be named ``inference.py`` and should implement
290+
either a pair of ``input_handler`` and ``output_handler`` functions or
291+
a single ``handler`` function.
290292
Note that if ``handler`` function is implemented, ``input_handler``
291293
and ``output_handler`` are ignored.
292294

@@ -453,6 +455,7 @@ processing. There are 2 ways to do this:
453455
model_data='s3://mybucket/model.tar.gz',
454456
role='MySageMakerRole')
455457
458+
For more information, see: https://github.com/aws/sagemaker-tensorflow-serving-container#prepost-processing
456459

457460
Deploying more than one model to your Endpoint
458461
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)