Skip to content

Commit

Permalink
Add an outline of software design doc (#126)
Browse files Browse the repository at this point in the history
* Fix code inside list

* Added skeleton of the software design doc
  • Loading branch information
apaleyes authored Mar 22, 2022
1 parent 9423454 commit 014f6ae
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@

1. Git clone seldon-core-v2

```bash
git clone https://github.com/SeldonIO/seldon-core-v2
```
3. Build [Seldon CLI](../cli.md)
4. Install [Docker Compose](https://docs.docker.com/compose/install/).
5. Install `make`.
git clone https://github.com/SeldonIO/seldon-core-v2

2. Build [Seldon CLI](../cli.md)
3. Install [Docker Compose](https://docs.docker.com/compose/install/).
4. Install `make`.


## Deploy
Expand Down
36 changes: 36 additions & 0 deletions docs/source/contents/software-design.md
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
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@
:includehidden:
contents/getting-started/index
contents/software-design
```

0 comments on commit 014f6ae

Please sign in to comment.