Skip to content
GitHub Action edited this page Oct 16, 2026 · 8 revisions

iso_doc_type: "Description" iso_viewpoint: "ArchitectureDescription" type: "architecture" title: "Master Wiki Index β€” ISO Architecture Description" description: "Master index of the MLOps Python Package documentation under ISO/IEC/IEEE 42010:2022 and 15289:2019 standards." tags: ["iso42010", "iso15289", "index", "architecture_description"] timestamp: "2026-10-01T17:50:00Z" generated: "agent:wiki-iso-documentation-standard" verified: "true" last_verified_commit: "073b5fd"

Master Documentation Index β€” MLOps Python Package

Standards Compliance: ISO/IEC/IEEE 42010:2022 (Architecture Descriptions) & ISO/IEC/IEEE 15289:2019 (Life Cycle Information Items).


πŸ“Œ Navigation & Entry Points


1. Stakeholder Perspectives & Concerns Matrix (ISO 42010)

Stakeholder Persona Primary Concerns Framing ISO Viewpoint Governed Wiki Document
Lead Data Scientist Model accuracy, baseline comparison, SHAP feature attributions ContextView & ComponentView Business Context, Lifecycle Jobs
MLOps Engineer CI/CD pipelines, experiment tracking, model registry promotion ComponentView & SequenceView Tactical Design, Runtime Sequences
Security & Compliance Auditor Model integrity, input sanitization, EU AI Act conformity SecurityView & QualityView Security Architecture, Compliance Audit
Platform / DevOps Engineer Kafka streaming latency, Docker deployment, resource quotas DeploymentView & Operations Infrastructure Adapters, Production Operations

2. Architecture Viewpoints (ISO 42010)

Viewpoint Document Description
ContextView Business Context Business justification, ROI model, KPIs, and ML lifecycle stages.
ContextView Strategic Design C4 Level 1-2, Onion Architecture, Bounded Contexts.
ComponentView Tactical Design C4 Level 3 Component diagram, design patterns (Strategy, Factory, Singleton).
ComponentView Lifecycle Job Specs Specification of all 6 jobs (base.Job, Training, Tuning, Eval, Explain, Infer, Promote).
SequenceView Runtime Sequences 4 comprehensive Mermaid execution sequences for batch and streaming pipelines.
ComponentView Data Model & Contracts Pandera schemas, Parquet lineage, Kafka JSON payload contracts.
ComponentView Infrastructure Adapters MLflow Tracking Server, MinIO/S3, Confluent Kafka, DVC, Logging/Alerts.

3. Security & Governance (ISO 42010 SecurityView & Policies)

Topic Document Description
SecurityView Security Architecture STRIDE threat model, cryptographic model signing, rate limiting, DoS protection.
Policy HITL Governance 4-Vertex Human-in-the-Loop governance mesh & promotion threshold verification.
Policy Verification Triad Logical, Architectural, and Security quality gates.
Report Compliance & Audit EU AI Act conformity assessment, reproducibility standards, experiment auditability.

4. Operations, Deployment & Quality (ISO 15289 & 25010)

Topic Document Description
Procedure User Manual Step-by-step guides for environment setup, data generation, CLI, and REST endpoints.
DeploymentView Production Operations Docker containerization, Docker Compose multi-service setup, runbook & troubleshooting.
Report Experiment Logs MLflow tracking schema, parameters, metrics, and artifact layout.
QualityView Test Plan & Report ISO 25010 software quality evaluation, 29 Pytest suites, performance benchmarks.
QualityView Lab Notebook EXP-2026-008 Empirical benchmark: Deterministic Verification vs. LLM-as-a-Judge Bias (50 mutations, 44% FNR).

5. 1:1 Structural Codebase Mirror (Modules)

Subsystem Source Path Wiki Specification Page Key Symbols
Root src/regression_model_template/__init__.py init.md Package metadata
Root src/regression_model_template/__main__.py main.md CLI dispatcher
Root src/regression_model_template/init_data.py init_data.md generate_data
Root src/regression_model_template/scripts.py scripts.md main
Root src/regression_model_template/settings.py settings.md Settings, MainSettings
controller src/regression_model_template/controller/__init__.py controller/init.md Controller exports
controller src/regression_model_template/controller/kafka_app.py kafka_app.md RateLimiter, PredictionRequest, FastAPIKafkaService
core src/regression_model_template/core/__init__.py core/init.md Core domain exports
core src/regression_model_template/core/metrics.py metrics.md Metric, SklearnMetric, Threshold
core src/regression_model_template/core/models.py models.md Model, BaselineSklearnModel
core src/regression_model_template/core/schemas.py schemas.md InputsSchema, TargetsSchema, OutputsSchema
io src/regression_model_template/io/__init__.py io/init.md I/O layer exports
io src/regression_model_template/io/configs.py configs.md parse_file, merge_configs
io src/regression_model_template/io/datasets.py datasets.md Reader, ParquetReader, Writer, ParquetWriter
io src/regression_model_template/io/osvariables.py osvariables.md Singleton, Env
io src/regression_model_template/io/registries.py registries.md Loader, Register, MlflowRegister
io src/regression_model_template/io/services.py services.md Service, LoggerService, MlflowService
jobs src/regression_model_template/jobs/__init__.py jobs/init.md Jobs layer exports
jobs src/regression_model_template/jobs/base.py base.md Job (Context manager base)
jobs src/regression_model_template/jobs/evaluations.py evaluations.md EvaluationsJob
jobs src/regression_model_template/jobs/explanations.py explanations.md ExplanationsJob (SHAP)
jobs src/regression_model_template/jobs/inference.py inference.md InferenceJob
jobs src/regression_model_template/jobs/promotion.py promotion.md PromotionJob
jobs src/regression_model_template/jobs/training.py training.md TrainingJob
jobs src/regression_model_template/jobs/tuning.py tuning.md TuningJob
utils src/regression_model_template/utils/__init__.py utils/init.md Utilities exports
utils src/regression_model_template/utils/searchers.py searchers.md Searcher, GridCVSearcher
utils src/regression_model_template/utils/signers.py signers.md Signer, InferSigner
utils src/regression_model_template/utils/splitters.py splitters.md Splitter, TrainTestSplitter, TimeSeriesSplitter

Clone this wiki locally