Skip to content

Commit d84dce3

Browse files
committed
update README, simplified fig
Signed-off-by: Sunyanan Choochotkaew <[email protected]>
1 parent c85e266 commit d84dce3

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,34 @@
22
[Get started with Kepler Model Server.](https://sustainable-computing.io/kepler_model_server/get_started/)
33

44
This repository contains source code related to Kepler power model. The modules in this reposioty connects to [core Kepler project](https://github.com/sustainable-computing-io/kepler) and [kepler-model-db](https://github.com/sustainable-computing-io/kepler-model-db) as below.
5-
![](./fig/model-server-components-simplified.png)
5+
![](./fig/comm_diagram.png)
6+
7+
For more detail, check [the component diagram](./fig/model-server-components-simplified.png).
68

79
## Model server and estimator deployment
810

11+
### By Kepler Operator
12+
13+
```yaml
14+
apiVersion: kepler.system.sustainable.computing.io/v1alpha1
15+
kind: KeplerInternal
16+
metadata:
17+
name: kepler
18+
spec:
19+
..
20+
modelServer:
21+
enabled: <true|false>
22+
estimator:
23+
node:
24+
components:
25+
sidecar: <true|false>
26+
initUrl: <static model URL>
27+
total:
28+
sidecar: <true|false>
29+
initUrl: <static model URL>
30+
```
31+
32+
### By manifests with setup script:
933
Deploy with estimator sidecar
1034
```
1135
OPTS="ESTIMATOR" make deploy
@@ -17,8 +41,8 @@ OPTS="ESTIMATOR SERVER" make deploy
1741
```
1842

1943
## Model training
20-
- [Use Tekton pipeline](./model_training/tekton/)
21-
- [Use Bash script with CPE operator](./model_training/)
44+
- [Use Tekton pipeline](./model_training/tekton/README.md)
45+
- [Use Bash script with CPE operator](./model_training/cpe_script_instruction.md)
2246

2347
## Local test
2448
### via docker

fig/comm_diagram.png

347 KB
Loading

0 commit comments

Comments
 (0)