Skip to content

Commit

Permalink
Docs update (#150)
Browse files Browse the repository at this point in the history
* update docs

* lint

* Add API docs

* further docs

* add local examples

* add k8s examples

* rewrite about
  • Loading branch information
ukclivecox authored Apr 18, 2022
1 parent f998108 commit 4dca12f
Show file tree
Hide file tree
Showing 108 changed files with 7,954 additions and 978 deletions.
3 changes: 0 additions & 3 deletions docs/source/contents/about/features/index.md

This file was deleted.

20 changes: 17 additions & 3 deletions docs/source/contents/about/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
# About

Seldon V2 APIs provide a state of the art solution for machine learning inference which can be run locally on a laptop as well as on Kubernetes for production.

## Features

* A single platform for inference.
* Deploy a wide range of model artifacts and custom models with a single solution.
* Deploy locally in Docker during development and testing of models.
* Deploy at scale on Kubernetes for production.
* Deploy single models to multi-step pipelines.
* Save infrastructure costs by deploys multiple models transparently in inference servers.
* Overcommit on resources to deploy more models than available memory.
* Dynamically extended models with pipelines with a data-centric perspective backed by Kafka
* Explain individual models and pipeliens with state of the art explanation techniques
* Deploy drift and outlier detectors alongside models
* Kubernetes Service mesh agnostic - use the service mesh of your choice.


```{toctree}
:maxdepth: 1
:hidden:
features/index.md
```

Introduction to Seldon Core V2 APIs.
6 changes: 6 additions & 0 deletions docs/source/contents/apis/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# APIs

Seldon provides APIs for management and inference.

* [API for inference](./inference/index.md)
* [Scheduler API for management](./scheduler/index.md) (Advanced)
* [Internal APIs](./internal/index.md) (Reference)

```{toctree}
:maxdepth: 1
:hidden:
inference/index.md
scheduler/index.md
internal/index.md
```
16 changes: 16 additions & 0 deletions docs/source/contents/apis/inference/index.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,18 @@
# Inference API

Seldon inference servers must respect the following API specification.

* [Seldon, KServe, NVIDIA V2 Inference API Spec](./v2.md)

In future, Seldon will provide extensions for use with Pipelines, Experiments and Explainers.

```{toctree}
:maxdepth: 1
:hidden:
v2.md
```




Loading

0 comments on commit 4dca12f

Please sign in to comment.