Skip to content

Commit ec6b831

Browse files
committed
Update readme
1 parent da3ca96 commit ec6b831

1 file changed

Lines changed: 15 additions & 37 deletions

File tree

README.md

Lines changed: 15 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1+
# Cascade - Small-scale MLOps Library
2+
3+
Lightweight and modular MLOps library with the aim to make ML development more efficient targeted at small teams or individuals.
4+
15
![header](cascade/docs/imgs/header.png)
26

37
![ver](https://img.shields.io/github/v/release/oxid15/cascade?style=plastic)
48
![build](https://github.com/oxid15/cascade/actions/workflows/python-package.yml/badge.svg)
59
[![Downloads](https://pepy.tech/badge/cascade-ml)](https://pepy.tech/project/cascade-ml)
610
[![DOI](https://zenodo.org/badge/460920693.svg)](https://zenodo.org/badge/latestdoi/460920693)
711

8-
Lightweight and modular MLOps library with the aim to make ML development more efficient targeted at small teams or individuals.
9-
10-
Cascade was built especially for individuals or small teams that are in need of MLOps, but don't have time or resources to integrate with platforms.
12+
Cascade offers the solution that enables MLOps features for small projects while demanding little. There is usually no need for the full MLOps setups in most of the small-scale ML-projects.
1113

1214
**Included in [Model Lifecycle](https://github.com/kelvins/awesome-mlops#model-lifecycle) section of Awesome MLOps list**
1315

@@ -50,7 +52,7 @@ ds = cdd.RandomSampler(ds)
5052
train_ds, test_ds = cdd.split(ds)
5153
train_ds = cdd.ApplyModifier(
5254
train_ds,
53-
lambda pair: pair + np.random.random() * 0.1 - 0.05
55+
lambda pair: pair[0] + np.random.random() * 0.1 - 0.05, pair[1]
5456
)
5557

5658
pprint(train_ds.get_meta())
@@ -98,7 +100,6 @@ We see all the stages that we did in meta.
98100
See all datasets in [zoo](https://oxid15.github.io/cascade/en/latest/modules/dataset_zoo.html)
99101
See tutorial in [documentation](https://oxid15.github.io/cascade/en/latest/tutorials/tutorials.html)
100102

101-
102103
### Experiment tracking
103104

104105
Cascade provides a rich set of ML-experiment tracking tools.
@@ -122,7 +123,6 @@ line.save(model, only_meta=True)
122123
`Repo` is the collection of lines and `Line` can be a bunch of experiments on one model type.
123124
Lines can also store data pipelines.
124125

125-
126126
<details>
127127
<summary>Click to see full model metadata</summary>
128128

@@ -156,47 +156,25 @@ Lines can also store data pipelines.
156156

157157
</details>
158158

159-
160159
See tutorial in [documentation](https://oxid15.github.io/cascade/en/latest/tutorials/tutorials.html)
161160

161+
## Cascade UI
162162

163-
### Metadata analysis
164-
165-
During experiments Cascade produces many metadata which can be analyzed later.
166-
`MetricViewer` is the tool that allows to see the relationship between parameters and
167-
metrics of all models in repository.
168-
169-
```python
170-
from cascade.meta import MetricViewer
171-
from cascade.repos import Repo
163+
Cascade features web-based experiment dashboard. You can install it with:
172164

173-
repo = cdm.Repo("repo")
174-
175-
# This runs web-server that relies on optional dependency
176-
MetricViewer(repo).serve()
165+
```bash
166+
pip install cascade-ui
177167
```
178168

179-
![metric-viewer](cascade/docs/imgs/metric-viewer.gif)
180-
181-
`HistoryViewer` allows to see model's lineage, what parameters resulted in what metrics
182-
183-
```python
184-
from cascade import meta as cme
185-
from cascade.repos import Repo
169+
Then locate your Cascade Workspace and run:
186170

187-
188-
repo = cdm.Repo("repo")
189-
190-
# This returns plotly figure
191-
cme.HistoryViewer(repo).plot()
192-
193-
# This runs a dash server and allows to see changes in real time (for example while models are trained)
194-
cme.HistoryViewer(repo).serve()
171+
```bash
172+
cascade ui
195173
```
196174

197-
See tutorial in [documentation](https://oxid15.github.io/cascade/en/latest/tutorials/tutorials.html)
175+
[Cascade UI](https://github.com/Laiserk/cascade_ui) is a separate project, that provides visual interface for Cascade experiments. For more detailed explanation you can visit [UI docs](https://oxid15.github.io/cascade/en/latest/tutorials/ui.html).
198176

199-
![history-viewer](cascade/docs/imgs/history-viewer.gif)
177+
![Cascade UI Model Page](cascade/docs/imgs/model-page.png)
200178

201179
## Who could find Cascade useful
202180

0 commit comments

Comments
 (0)