Skip to content

Commit

Permalink
python wrapper docs: move metadata entry to incubating
Browse files Browse the repository at this point in the history
  • Loading branch information
RafalSkolasinski authored and seldondev committed Apr 2, 2020
1 parent d4c435e commit 0cad23b
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions doc/source/python/python_component.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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).

0 comments on commit 0cad23b

Please sign in to comment.