From e5e87ad40b9ff4942e79c8a8c75c80a97fbc6743 Mon Sep 17 00:00:00 2001 From: Rafal Skolasinski Date: Wed, 1 Apr 2020 09:40:27 +0100 Subject: [PATCH] python wrapper docs: move metadata entry to incubating --- doc/source/python/python_component.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/doc/source/python/python_component.md b/doc/source/python/python_component.md index 0163c418d0..609524a622 100644 --- a/doc/source/python/python_component.md +++ b/doc/source/python/python_component.md @@ -148,9 +148,6 @@ class ModelWithMetrics(object): return {"system":"production"} ``` -## REST Metadata Endpoint -The python wrapper will automatically expose a `/metadata` endpoint to return metadata about the loaded model. It is up to the developer to implement a `metadata` method in their class to provide an arbitrary Dict back containing the model metadata.\ - ## REST Health Endpoint If you wish to add a REST health point, you can implement the `health_status` method with signature as shown below: ```python @@ -427,6 +424,18 @@ class Model: # Make predictions using float_array ``` + +## Incubating features + + +### REST Metadata Endpoint +The python wrapper will automatically expose a `/metadata` endpoint to return metadata about the loaded model. +It is up to the developer to implement a `metadata` method in their class to provide an arbitrary `dict` back containing the model metadata. + +Note: future work will most likely standardize `/metadata` endpoint and change behaviour of this method. See [this](https://github.com/SeldonIO/seldon-core/issues/1638) GitHub issue for details. + + + ## Next Steps After you have created the Component you need to create a Docker image that can be managed by Seldon Core. Follow the documentation to do this with [s2i](./python_wrapping_s2i.md) or [Docker](./python_wrapping_docker.md).