-
Notifications
You must be signed in to change notification settings - Fork 835
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add an outline of software design doc (#126)
* Fix code inside list * Added skeleton of the software design doc
- Loading branch information
Showing
3 changed files
with
42 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Seldon Core v2 design | ||
|
||
Seldon Core underwent a complete re-design internally, compared to version 1. Here we go over the main concepts and design decisions taken in V2. | ||
|
||
## Inference graph | ||
|
||
This section talks about inference graph and its components. | ||
|
||
## Dataflow paradigm | ||
|
||
What is dataflow, how it is different from v1. | ||
|
||
## Data streams and Kafka | ||
|
||
Introducing data streams and Kafka, explain why we decided to go with it. | ||
|
||
## Dataflow graph in SCv2 | ||
|
||
### General overview | ||
General description of our approach, maybe a nice diagram of a sample dataflow graph | ||
|
||
### Chainer | ||
|
||
Explain what is the chainer component and what it is responsible for | ||
|
||
### Gateways | ||
|
||
Talk about the components that streams of data to and from service calls | ||
|
||
### Error handling | ||
|
||
How do we handle errors | ||
|
||
## Why? | ||
|
||
Greater flexibility, decentralized approach, native support for async scenarios, data lineage possible throughout |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,4 +6,5 @@ | |
:includehidden: | ||
contents/getting-started/index | ||
contents/software-design | ||
``` |