From 5fa08b813d035259e22170eac8ebf9587e619c67 Mon Sep 17 00:00:00 2001 From: Choudary Hussain Ali <210404880+choudaryhussainali@users.noreply.github.com> Date: Tue, 12 Aug 2025 06:42:30 -0700 Subject: [PATCH] Fix typos and improve clarity This PR fixes minor typos, grammar, and formatting issues in the Getting Started and Quick Start sections of the MLSysOps documentation. - Corrected capitalization of "Ansible" - Changed "setup" to "set up" where appropriate - Replaced "re-trainable" with "retrainable" - Improved sentence clarity and consistency - Added missing punctuation and fixed hyphenation for terms like "AI-ready" and "FaaS-style" These improvements enhance readability and ensure the documentation follows standard technical writing conventions. Thank you for considering this contribution! --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f44b6ea..b7383f0 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,41 @@ # MLSysOps Framework -The *MLSysOps Framework* is the open‑source outcome of the EU‑funded MLSysOps -Horizon Europe project (Grant ID 101092912), running from Jan 2023 to Dec 2025. -Its aim is to deliver an AI‑enabled, agent‑based platform for autonomic, -cross‑layer management of compute, storage, and network resources across cloud, +The *MLSysOps Framework* is the open-source outcome of the EU-funded MLSysOps +Horizon Europe project (Grant ID 101092912), running from Jan 2023 to Dec 2025. +Its aim is to deliver an AI-enabled, agent-based platform for autonomic, +cross-layer management of compute, storage, and network resources across cloud, edge, and IoT environments. ## Key Objectives -- Provide an *open, AI‑ready framework* for scalable, trustworthy, +- Provide an *open, AI-ready framework* for scalable, trustworthy, explainable system operation across heterogeneous infrastructures. - Enable *continual ML learning* and retraining during runtime via hierarchical agents. - Support *portable, efficient execution* using container innovation and modular, FaaS-inspired offloading. -- Promote *green, resource‑efficient, and secure operations* while +- Promote *green, resource-efficient, and secure operations* while maintaining `QoS`/`QoE` targets. -- Facilitate realistic evaluation using real-world deployments in smart‑city - and precision‑agriculture scenarios. +- Facilitate realistic evaluation using real-world deployments in smart-city + and precision-agriculture scenarios. ## Core Components - Hierarchical Agent Architecture: Interfaces with orchestration/control - systems and exposes an ML‑model API for plug‑and‑play explainable/re-trainable + systems and exposes an ML-model API for plug-and-play explainable/retrainable models. - Telemetry & Control Knobs: Collects metrics across the continuum and adjusts configuration (e.g., compute, network, storage, accelerator usage) dynamically. -- Distributed FaaS‑style Executor: Enables function offloading across tiers to +- Distributed FaaS-style Executor: Enables function offloading across tiers to optimize latency, energy, and performance. - Explainable ML & Reinforcement Learning Module: Offers transparent decisions, highlighting input factors influencing agent actions. -- Use-cases: Includes real applications focusing on smart cities and agriculture. +- Use cases: Includes real applications focusing on smart cities and agriculture. ## Repository Contents @@ -56,6 +56,14 @@ edge, and IoT environments. - Python 3.10+ - Access to a 4-node testbed environment +### Quick Start + +Install the CLI tool: + +```bash +pip install mlsysops-cli + + ### Quick Start Install the CLI tool: