Merge pull request #279 from Oxid15/develop

v0.16.0

Author: Oxid15

README.md

@@ -1,13 +1,15 @@
+# Cascade - Small-scale MLOps Library
+
+Lightweight and modular MLOps library with the aim to make ML development more efficient targeted at small teams or individuals.
+
 ![header](cascade/docs/imgs/header.png)
 
 ![ver](https://img.shields.io/github/v/release/oxid15/cascade?style=plastic)
 ![build](https://github.com/oxid15/cascade/actions/workflows/python-package.yml/badge.svg)
 [![Downloads](https://pepy.tech/badge/cascade-ml)](https://pepy.tech/project/cascade-ml)
 [![DOI](https://zenodo.org/badge/460920693.svg)](https://zenodo.org/badge/latestdoi/460920693)
 
-Lightweight and modular MLOps library with the aim to make ML development more efficient targeted at small teams or individuals.
-
-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.
+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.
 
 **Included in [Model Lifecycle](https://github.com/kelvins/awesome-mlops#model-lifecycle) section of Awesome MLOps list**
 
@@ -50,7 +52,7 @@ ds = cdd.RandomSampler(ds)
 train_ds, test_ds = cdd.split(ds)
 train_ds = cdd.ApplyModifier(
     train_ds,
-    lambda pair: pair + np.random.random() * 0.1 - 0.05
+    lambda pair: pair[0] + np.random.random() * 0.1 - 0.05, pair[1]
 )
 
 pprint(train_ds.get_meta())
@@ -98,7 +100,6 @@ We see all the stages that we did in meta.
 See all datasets in [zoo](https://oxid15.github.io/cascade/en/latest/modules/dataset_zoo.html)  
 See tutorial in [documentation](https://oxid15.github.io/cascade/en/latest/tutorials/tutorials.html)
 
-
 ### Experiment tracking
 
 Cascade provides a rich set of ML-experiment tracking tools.
@@ -122,7 +123,6 @@ line.save(model, only_meta=True)
 `Repo` is the collection of lines and `Line` can be a bunch of experiments on one model type.
 Lines can also store data pipelines.
 
-
 <details>
 <summary>Click to see full model metadata</summary>
 
@@ -156,47 +156,25 @@ Lines can also store data pipelines.
 
 </details>
 
-
 See tutorial in [documentation](https://oxid15.github.io/cascade/en/latest/tutorials/tutorials.html)
 
+## Cascade UI
 
-### Metadata analysis
-
-During experiments Cascade produces many metadata which can be analyzed later.
-`MetricViewer` is the tool that allows to see the relationship between parameters and
-metrics of all models in repository.
-
-```python
-from cascade.meta import MetricViewer
-from cascade.repos import Repo
+Cascade features web-based experiment dashboard. You can install it with:
 
-repo = cdm.Repo("repo")
-
-# This runs web-server that relies on optional dependency
-MetricViewer(repo).serve()
+```bash
+pip install cascade-ui
 ```
 
-![metric-viewer](cascade/docs/imgs/metric-viewer.gif)
-
-`HistoryViewer` allows to see model's lineage, what parameters resulted in what metrics
-
-```python
-from cascade import meta as cme
-from cascade.repos import Repo
+Then locate your Cascade Workspace and run:
 
-
-repo = cdm.Repo("repo")
-
-# This returns plotly figure
-cme.HistoryViewer(repo).plot()
-
-# This runs a dash server and allows to see changes in real time (for example while models are trained)
-cme.HistoryViewer(repo).serve()
+```bash
+cascade ui
 ```
 
-See tutorial in [documentation](https://oxid15.github.io/cascade/en/latest/tutorials/tutorials.html)
+[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).
 
-![history-viewer](cascade/docs/imgs/history-viewer.gif)
+![Cascade UI Model Page](cascade/docs/source/_static/model-page.png)
 
 ## Who could find Cascade useful
 

cascade/base/traceable.py

@@ -20,6 +20,7 @@
 import warnings
 from dataclasses import asdict, dataclass
 from datetime import datetime
+from functools import wraps
 from getpass import getuser
 from typing import Any, Callable, Dict, Iterable, Optional, Union
 
@@ -54,6 +55,18 @@ def __post_init__(self) -> None:
             self.uri = os.path.abspath(self.uri)
 
 
+def apply_prefix(get_meta):
+    @wraps(get_meta)
+    def wrapper(self, *args, **kwargs):
+        meta = get_meta(self, *args, **kwargs)
+        if hasattr(self, "_meta_prefix"):
+            meta[0].update(self._meta_prefix)
+        else:
+            self._warn_no_prefix()
+        return meta
+    return wrapper
+
+
 class Traceable:
     """
     Base class for everything that has metadata in Cascade
@@ -89,6 +102,7 @@ def __init__(
         self.comments = list()
         self.links = list()
 
+    @apply_prefix
     def get_meta(self) -> Meta:
         """
         Returns
@@ -104,10 +118,6 @@ def get_meta(self) -> Meta:
         """
         meta = {}
         meta["name"] = repr(self)
-        if hasattr(self, "_meta_prefix"):
-            meta.update(self._meta_prefix)
-        else:
-            self._warn_no_prefix()
 
         if hasattr(self, "description"):
             meta["description"] = self.description
@@ -197,7 +207,7 @@ def from_meta(self, meta: Union[Meta, MetaBlock]) -> None:
             self.links = [Link(**link) for link in meta[0]["links"]]
             del meta[0]["links"]
 
-        self.update_meta(meta)
+        self.update_meta(meta[0])
 
     def __repr__(self) -> str:
         """

cascade/cli/artifact.py

@@ -79,7 +79,9 @@ def remove_repo_artifacts(path) -> List[List[List[RemoveResult]]]:
     repo = create_container("repo", path)
     repo_results = []
     for name in repo.get_line_names():
-        results = remove_line_artifacts(os.path.join(path, name))
+        line_meta = repo[name].get_meta()
+        line_type = line_meta[0].get("type", "model_line")
+        results = remove_line_artifacts(os.path.join(path, name), line_type)
         repo_results.append(results)
     return repo_results
 

cascade/cli/cli.py

@@ -18,14 +18,14 @@
 
 import click
 
-from ..base import MetaHandler, MetaIOError
 from .artifact import artifact
 from .comment import comment
-from .common import create_container
+from .common import create_container, init_ctx
 from .desc import desc
 from .query import query
 from .run import run
 from .tag import tag
+from .ui import ui
 from .view import view
 
 
@@ -40,14 +40,7 @@ def cli(ctx):
     current_dir_full = os.getcwd()
     ctx.obj["cwd"] = current_dir_full
 
-    try:
-        meta = MetaHandler.read_dir(current_dir_full)
-        ctx.obj["meta"] = meta
-        ctx.obj["type"] = meta[0].get("type")
-        ctx.obj["len"] = meta[0].get("len")
-        ctx.obj["meta_fmt"] = MetaHandler.determine_meta_fmt(current_dir_full, "meta.*")
-    except MetaIOError as e:
-        click.echo(e)
+    init_ctx(ctx, current_dir_full)
 
 
 @cli.command
@@ -112,6 +105,7 @@ def migrate(ctx):
 cli.add_command(run)
 cli.add_command(query)
 cli.add_command(tag)
+cli.add_command(ui)
 cli.add_command(view)
 
 

cascade/cli/common.py

@@ -16,6 +16,21 @@
 
 from typing import Any
 
+import click
+
+from ..base import MetaHandler, MetaIOError
+
+
+def init_ctx(ctx, path):
+    try:
+        meta = MetaHandler.read_dir(path)
+        ctx.obj["meta"] = meta
+        ctx.obj["type"] = meta[0].get("type")
+        ctx.obj["len"] = meta[0].get("len")
+        ctx.obj["meta_fmt"] = MetaHandler.determine_meta_fmt(path, "meta.*")
+    except MetaIOError as e:
+        click.echo(e)
+
 
 def create_container(type: str, cwd: str) -> Any:
     # "line" fallback here is for compatibility

cascade/cli/run.py

@@ -26,7 +26,6 @@
 
 import click
 import pendulum
-
 from cascade.base import MetaHandler
 
 
@@ -60,7 +59,7 @@ def find_config(tree: ast.Module) -> Optional[ast.ClassDef]:
         if isinstance(node, ast.ClassDef):
             if len(node.bases):
                 for base in node.bases:
-                    if base.id == "Config":
+                    if getattr(base, "id", None) == "Config":
                         if cfg_node is not None:
                             more_than_one = True
                         cfg_node = node
@@ -151,9 +150,12 @@ def modify_assignments(tree: ast.Module, cfg_node: ast.ClassDef, kwargs: Dict[st
 
 def parse_args(args):
     kwargs = {}
-    for key, val in zip(args[::2], args[1::2]):
-        key = re.sub(r"^-{1,2}\b", "", key)
-        kwargs[key] = ast.literal_eval(val)
+    for orig_key, val in zip(args[::2], args[1::2]):
+        key = re.sub(r"^-{1,2}\b", "", orig_key)
+        try:
+            kwargs[key] = ast.literal_eval(val)
+        except Exception as e:
+            raise RuntimeError(f"Failed to parse the following argument: {orig_key} {val} See traceback above.") from e
     return kwargs
 
 

cascade/cli/ui.py

@@ -0,0 +1,56 @@
+"""
+Copyright 2022-2025 Ilia Moiseev
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+import os
+
+import click
+
+from .common import init_ctx
+
+
+@click.command("ui")
+@click.option("--path", default=".")
+@click.option("--host", default="127.0.0.1")
+@click.option("--port", default=8000)
+@click.pass_context
+def ui(ctx, path, host, port):
+    if not os.path.exists(os.path.join(path, "meta.json")):
+        click.echo("This folder is not a Cascade Workspace, would you like to create one?")
+        response = input("y/n: ")
+        if response.lower() == "y":
+            from cascade.workspaces import Workspace
+
+            Workspace(path)
+            init_ctx(ctx, path)
+        else:
+            click.echo("Exiting...")
+            return
+
+    if ctx.obj["meta"][0]["type"] != "workspace":
+        click.echo("UI is only available inside workspaces")
+        return
+
+    try:
+        from cascade_ui.app import run
+    except ImportError as e:
+        if "No module named 'cascade_ui'" in e.msg:
+            raise ImportError(
+                "cascade_ui package is required to run UI. Install it with 'pip install cascade-ui'"
+            ) from e
+        else:
+            raise e
+    else:
+        run(path, host, port)

cascade/data/modifier.py

@@ -28,6 +28,14 @@ def get_meta(self) -> Meta:
         self_meta += self._dataset.get_meta()
         return self_meta
 
+    def update_meta(self, meta):
+        if isinstance(meta, list):
+            super().update_meta(meta[0])
+            if len(meta) > 1:
+                self._dataset.update_meta(meta[1:])
+        else:
+            super().update_meta(meta)
+
     def from_meta(self, meta: Meta) -> None:
         """
         Calls the same method as base class but does