pipelab 0.1.0__tar.gz

pipelab-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2026 Tarlis Tortelli Portela <tarlis@tarlis.com.br>
+
+   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.

pipelab-0.1.0/PKG-INFO

@@ -0,0 +1,376 @@
+Metadata-Version: 2.4
+Name: pipelab
+Version: 0.1.0
+Summary: PipeLab — ML Pipeline Management Platform with MLflow, FastAPI and React
+Author: Tarlis Portela
+License-Expression: Apache-2.0
+Keywords: machine-learning,mlops,pipelines,mlflow,experiment-tracking,model-registry
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Framework :: FastAPI
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi
+Requires-Dist: uvicorn[standard]
+Requires-Dist: typer
+Requires-Dist: mlflow
+Requires-Dist: pydantic
+Requires-Dist: scikit-learn
+Requires-Dist: pandas
+Requires-Dist: python-multipart
+Requires-Dist: httpx
+Requires-Dist: pyyaml
+Dynamic: license-file
+
+# PipeLab — ML Pipeline Management Platform
+
+A Python platform for managing end-to-end Machine Learning pipelines, backed by **MLflow** for experiment tracking and model registry, with a **FastAPI** backend and **React + TailwindCSS** frontend.
+
+---
+
+## Getting Started
+
+### Quick start (local)
+
+```bash
+./run.sh
+```
+
+This sets up the virtual environment (if needed), starts the MLflow UI at http://127.0.0.1:5000 and the pipelab server at http://localhost:8000, using the bundled `./workdir` (contains `project-01`). Options: `--workdir DIR`, `--port PORT`, `--mlflow-port PORT`, `--reload`.
+
+### Prerequisites
+
+- **Python** ≥ 3.10
+- **Node.js** ≥ 20 (only for frontend development)
+
+### 1. Create and activate a virtual environment
+
+```bash
+cd pipelab
+python -m venv .venv
+source .venv/bin/activate   # Linux / macOS
+# .venv\Scripts\activate    # Windows
+```
+
+### 2. Install pipelab in editable mode
+
+```bash
+pip install -e .
+```
+
+This installs all dependencies (FastAPI, MLflow, scikit-learn, pandas, etc.).
+
+### 3. Set up your working directory
+
+pipelab discovers projects from a **workdir** — a directory where each subdirectory containing an `pipelab.yaml` file is treated as a project.
+
+```bash
+# Create a workdir (or use any existing directory)
+mkdir -p ~/pipelab-workdir
+cd ~/pipelab-workdir
+
+# Initialize your first project
+pipelab init my-project --description "My first ML project"
+```
+
+This generates the following structure:
+
+```
+~/pipelab-workdir/
+└── my-project/
+    ├── pipelab.yaml      # Project configuration
+    ├── pipeline/       # Place your pipeline service classes here
+    ├── notebooks/      # Jupyter notebooks - for your organization
+    └── mlruns/         # Local MLflow tracking store
+```
+
+### 4. Start MLflow (optional — for the tracking UI)
+
+pipelab uses MLflow under the hood. You can optionally start the MLflow UI to inspect experiments directly:
+
+```bash
+# From within your workdir (runs on port 5000 by default)
+mlflow ui --backend-store-uri my-project/mlruns
+```
+
+Open http://localhost:5000 to view the MLflow dashboard.
+
+### 5. Start the pipelab server
+
+```bash
+# Serve from the workdir so pipelab discovers your projects
+pipelab serve --workdir ~/pipelab-workdir --port 8000
+```
+
+Open http://localhost:8000 in your browser.
+
+> **Tip:** If you run `pipelab serve` without `--workdir`, it defaults to the current directory.
+
+---
+
+## Features
+
+- **Project Workspaces** — Organize experiments by project with `pipelab.yaml` config
+- **Dataset Versioning** — Track dataset versions with metadata
+- **Data Split Management** — K-fold CV, train/test, custom splits
+- **Experiment Tracking** — Register experiments and runs via MLflow
+- **Benchmark & Comparison** — Compare runs side-by-side with charts
+- **Model Registry** — Register, version, and manage model lifecycle stages
+- **Pipeline Engine** — Define and execute sequential ML pipelines (data → preparation → experiment → deploy)
+- **Model Deployment** — Deploy models as REST endpoints
+- **Monitoring & Alerts** — Track prediction stats and drift indicators
+- **Plugin Architecture** — Extend with custom modules
+- **CLI** — `pipelab serve`, `pipelab init`, `pipelab run-pipeline`
+
+---
+
+## Architecture
+
+```
+pipelab/
+├── entities/        # Domain dataclasses + pipeline ABCs
+├── services/        # Abstract interfaces + MLflow implementations
+├── infrastructure/  # MLflow client wrapper
+├── pipelines/       # Pipeline execution engine
+├── plugins/         # Plugin base class
+├── api/             # FastAPI app + REST routers
+│   └── routers/     # projects, datasets, experiments, models, ...
+├── static/          # Built React frontend (served by FastAPI)
+└── cli.py           # Typer CLI commands
+```
+
+### Clean Architecture Layers
+
+| Layer | Location | Purpose |
+|-------|----------|---------|
+| Domain | `entities/` | Dataclasses, pipeline ABCs — the core data model |
+| Services | `services/interfaces.py` | Abstract contracts (ABCs) |
+| Infrastructure | `services/mlflow_*.py` | Concrete MLflow implementations |
+| API | `api/` | HTTP interface (FastAPI routers + Pydantic schemas) |
+| UI | `frontend/` → `static/` | React + TailwindCSS SPA |
+
+---
+
+## CLI Commands
+
+```bash
+# Start the web server (defaults to current directory as workdir)
+pipelab serve --host 0.0.0.0 --port 8000 --workdir ~/pipelab-workdir
+
+# Initialize a new project
+pipelab init my-project --description "My ML Project" --workdir ~/pipelab-workdir
+
+# Run all discovered pipeline services for a project
+pipelab run-pipeline ~/pipelab-workdir/my-project
+```
+
+---
+
+## Writing Pipeline Services
+
+Create Python files in your project's `pipeline/` directory. pipelab autodiscovers subclasses of the pipeline ABCs:
+
+```python
+# ~/pipelab-workdir/my-project/pipeline/data.py
+from pipelab.pipeline import DatasetService, PipelineContext
+
+class IrisLoader(DatasetService):
+    """Load the Iris dataset."""
+    def execute(self, context: PipelineContext):
+        from sklearn.datasets import load_iris
+        data = load_iris()
+        context.results["X"] = data.data
+        context.results["y"] = data.target
+        return {"samples": len(data.data)}
+```
+
+```python
+# ~/pipelab-workdir/my-project/pipeline/train.py
+from pipelab.pipeline import ExperimentService, PipelineContext
+
+class RandomForestTrainer(ExperimentService):
+    """Train a Random Forest classifier."""
+    def execute(self, context: PipelineContext):
+        from sklearn.ensemble import RandomForestClassifier
+        from sklearn.metrics import accuracy_score
+        import mlflow
+
+        X_train = context.data.X_train
+        y_train = context.data.y_train
+        X_test = context.data.X_test
+        y_test = context.data.y_test
+
+        clf = RandomForestClassifier(n_estimators=100, random_state=42)
+        clf.fit(X_train, y_train)
+        acc = accuracy_score(y_test, clf.predict(X_test))
+
+        with mlflow.start_run(experiment_id=context.experiment_name):
+            mlflow.log_metric("accuracy", acc)
+            mlflow.sklearn.log_model(clf, "model")
+
+        return {"accuracy": acc}
+```
+
+Configure preparation in `pipelab.yaml`:
+
+```yaml
+name: my-project
+datasets:
+  - name: iris
+    data_service: IrisLoader
+    preparation_method: TrainTestSplit
+    preparation_params:
+      test_size: 0.2
+      random_state: 42
+```
+
+Then run from the web UI or CLI:
+
+```bash
+pipelab run-pipeline ~/pipelab-workdir/my-project
+```
+
+---
+
+## Extending the Framework
+
+### Custom Services
+
+Implement any abstract interface from `pipelab.services.interfaces`:
+
+```python
+from pipelab.services.interfaces import DatasetService
+
+class MyDatasetService(DatasetService):
+    def list_datasets(self, project_id=None):
+        ...
+```
+
+### Plugins
+
+```python
+from pipelab.plugins import PipelabPlugin
+from fastapi import APIRouter
+
+class MyPlugin(PipelabPlugin):
+    @property
+    def name(self):
+        return "my-plugin"
+
+    def get_routes(self):
+        router = APIRouter()
+        @router.get("/hello")
+        async def hello():
+            return {"msg": "Hello from plugin!"}
+        return [router]
+```
+
+---
+
+## Frontend Development
+
+```bash
+cd pipelab/frontend
+npm install
+npm run dev     # Dev server with API proxy to :8000
+npm run build   # Build to ../static/
+```
+
+---
+
+## API Endpoints
+
+| Endpoint | Methods | Description |
+|----------|---------|-------------|
+| `/api/v1/projects/` | GET, POST, PUT | Project management |
+| `/api/v1/datasets/` | GET, POST, DELETE | Dataset CRUD + versions + splits |
+| `/api/v1/experiments/` | GET, POST, DELETE | Experiment management |
+| `/api/v1/experiments/{name}/runs` | GET | List experiment runs |
+| `/api/v1/experiments/runs/compare` | POST | Compare multiple runs |
+| `/api/v1/models/` | GET, POST, DELETE | Model registry |
+| `/api/v1/models/register` | POST | Register a model from a run |
+| `/api/v1/pipelines/services` | GET | List autodiscovered services |
+| `/api/v1/pipelines/run` | POST | Execute a pipeline |
+| `/api/v1/pipelines/dataset-configs` | GET, POST, DELETE | Dataset configurations |
+| `/api/v1/pipelines/eda/load` | POST | Load dataset for EDA |
+| `/api/v1/deployments/` | GET, POST, DELETE | Model deployments |
+| `/api/v1/monitoring/` | GET, POST | Prediction stats + alerts |
+| `/api/v1/settings/` | GET, PUT | Configuration |
+
+---
+
+## Requirements
+
+All Python dependencies are managed via `pyproject.toml` and installed automatically:
+
+| Package | Purpose |
+|---------|---------|
+| `fastapi` | REST API framework |
+| `uvicorn[standard]` | ASGI server |
+| `mlflow` | Experiment tracking & model registry |
+| `scikit-learn` | ML utilities & default preparation methods |
+| `pandas` | Data manipulation |
+| `pyyaml` | Project configuration parsing |
+| `typer` | CLI framework |
+| `pydantic` | Request/response validation |
+
+---
+
+## Building & Publishing to PyPI
+
+### 1. Build the frontend (bundles into `pipelab/static/`)
+
+```bash
+cd pipelab/frontend
+npm install
+npm run build
+cd ../..
+```
+
+### 2. Build the Python package
+
+```bash
+pip install build
+python -m build
+```
+
+This creates `dist/pipelab-X.Y.Z.tar.gz` and `dist/pipelab-X.Y.Z-py3-none-any.whl`.
+
+### 3. Upload to PyPI
+
+```bash
+pip install twine
+twine upload dist/*
+```
+
+> **Tip:** For test uploads, use TestPyPI first:
+> ```bash
+> twine upload --repository testpypi dist/*
+> pip install --index-url https://test.pypi.org/simple/ pipelab
+> ```
+
+### 4. Version bumps
+
+Update the version in `pyproject.toml`:
+
+```toml
+[project]
+version = "0.2.0"
+```
+
+Then rebuild and upload.
+
+---
+
+## License
+
+MIT