Skip to content

Commit

Permalink
Fix Documentation (#510)
Browse files Browse the repository at this point in the history
* Remove onnx from doc; add rtd torch & tf req

* Add mock imports

* remove extra deps

* Fix link
  • Loading branch information
simon-mo committed Jun 6, 2018
1 parent 38602a6 commit a665283
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 16 deletions.
2 changes: 2 additions & 0 deletions clipper_admin/docs/conf.py
Expand Up @@ -200,3 +200,5 @@ def setup(app):
# 'enable_auto_doc_ref': True,
# }, True)
# app.add_transform(AutoStructify)

autodoc_mock_imports = ['tensorflow', 'torch']
17 changes: 1 addition & 16 deletions clipper_admin/docs/model_deployers.rst
Expand Up @@ -130,24 +130,9 @@ For MXNet, Clipper will serialize the model using ``mxnet_model.save_checkpoint(
.. autofunction:: clipper_admin.deployers.mxnet.create_endpoint


PyTorch->ONNX->Caffe2 Models
----------------------------
.. warning::
ONNX support is experimental. The model container might not be stable. As of 0.3 release, we expect the Caffe2 backend will function with some limitation.

Similar to the PySpark deployer, this deployer provides a small extension to the Python closure deployer
to allow you to deploy Python functions that include PyTorch models deployed with the higher-performance
Caffe2 backend.

This module currently takes a PyTorch model, saves it to ONNX files, and serves it using Caffe2.

.. autofunction:: clipper_admin.deployers.onnx.deploy_pytorch_model
.. autofunction:: clipper_admin.deployers.onnx.create_pytorch_endpoint


Create Your Own Container
-------------------------

If none of the provided model deployers will meet your needs, you will need to create your own model container.

[Tutorial on building your own model container](http://clipper.ai/tutorials/custom_model_container).
`Tutorial on building your own model container <http://clipper.ai/tutorials/custom_model_container>`_

0 comments on commit a665283

Please sign in to comment.