Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mark model metadata in python wrapper as incubating feature in 1.1 docs #1649

Merged
merged 1 commit into from
Apr 2, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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).