Skip to content
This repository has been archived by the owner on Aug 26, 2020. It is now read-only.

Commit

Permalink
Add README description (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
winstonaws authored Apr 4, 2018
1 parent 71d8b7b commit 4e062cb
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,18 @@
SageMaker Container Support
===========================

This support code is used for making machine learning frameworks (e.g. MXNet, TensorFlow) run on Amazon SageMaker.
This package makes it easier to build docker images which run on Amazon SageMaker. For example, the official SageMaker `TensorFlow <https://github.com/aws/sagemaker-tensorflow-containers>`_ and `MXNet <https://github.com/aws/sagemaker-mxnet-containers>`_ images use this package. The requirements for SageMaker-compatible images are documented here: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html

Features provided:

- Integration with `SageMaker Python SDK <https://github.com/aws/sagemaker-python-sdk>`_ Estimators, including:

- Downloading user-provided python code
- Deserializing hyperparameters (which preserves their python types)

- ``bin/entry.py``, which acts as the docker entrypoint required by SageMaker
- Reading in the metadata files provided to the container during training, as described here: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo.html
- nginx + Gunicorn HTTP server for serving inference requests which complies with the interface described here: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html

License
-------
Expand Down

0 comments on commit 4e062cb

Please sign in to comment.