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

update README, simplified fig #223

Merged
merged 1 commit into from
Jan 28, 2024
Merged
Show file tree
Hide file tree
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
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,34 @@
[Get started with Kepler Model Server.](https://sustainable-computing.io/kepler_model_server/get_started/)

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.
![](./fig/model-server-components-simplified.png)
![](./fig/comm_diagram.png)

For more detail, check [the component diagram](./fig/model-server-components-simplified.png).

## Model server and estimator deployment

### By Kepler Operator

```yaml
apiVersion: kepler.system.sustainable.computing.io/v1alpha1
kind: KeplerInternal
metadata:
name: kepler
spec:
..
modelServer:
enabled: <true|false>
estimator:
node:
components:
sidecar: <true|false>
initUrl: <static model URL>
total:
sidecar: <true|false>
initUrl: <static model URL>
```

### By manifests with setup script:
Deploy with estimator sidecar
```
OPTS="ESTIMATOR" make deploy
Expand All @@ -17,8 +41,8 @@ OPTS="ESTIMATOR SERVER" make deploy
```

## Model training
- [Use Tekton pipeline](./model_training/tekton/)
- [Use Bash script with CPE operator](./model_training/)
- [Use Tekton pipeline](./model_training/tekton/README.md)
- [Use Bash script with CPE operator](./model_training/cpe_script_instruction.md)

## Local test
### via docker
Expand Down
Binary file added fig/comm_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.