diff --git a/README.md b/README.md index 3f7cb3b..b04f507 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,55 @@ LogSight-AI is a local-first Python CLI for parsing common log formats, summarizing error patterns, detecting message-length outliers, and locating error-rate spikes. The production package does not transmit logs or require credentials. + +## Production Readiness Guide + +> This section is the portfolio audit entry point for **LogSight-AI**. It describes an engineering promotion path; it is not a claim that the repository is already production-authorized. + +[![CI](https://img.shields.io/github/actions/workflow/status/CoreyLeath-code/LogSight-AI/ci.yml?branch=main&label=CI)](https://github.com/CoreyLeath-code/LogSight-AI/actions) [![License](https://img.shields.io/github/license/CoreyLeath-code/LogSight-AI)](https://github.com/CoreyLeath-code/LogSight-AI/blob/main/LICENSE) + +### Architecture flowchart + +```mermaid +flowchart LR + Input --> Validate[Schema + data checks] --> Model[Versioned model] --> Serve[API / dashboard] --> Observe[Metrics + drift] +``` + +### Quickstart and local validation + +The supported local path should be reproducible from a clean checkout. The inferred stack for this repository is **Python/ML**. + +```bash +python -m venv .venv && source .venv/bin/activate && pip install -r requirements.txt +pytest -q +``` + +If the project uses external services, model artifacts, cloud credentials, or private data, start them through documented local fixtures or mocks. Never place secrets or identifiable records in the repository. + +### Research-style metrics and benchmarks + +| Evidence | Required record | +|---|---| +| Correctness | Test command, commit SHA, runtime, and pass/fail result | +| Performance | Warm-up, sample count, concurrency, median, p95, p99, throughput, and memory | +| Data/model quality | Dataset version, split strategy, leakage controls, calibration, subgroup results, and uncertainty | +| Runtime | Image digest, health-check latency, resource limits, and rollback target | +| Security | Dependency, secret, SAST, container, and SBOM results | + +A benchmark number belongs in a versioned artifact tied to a commit and hardware/runtime description. Engineering benchmarks must not be presented as clinical, financial, safety, or model-quality validation without the appropriate domain evidence. + +### Extended Q&A + +**What is production-ready for this repository?** +A reproducible build, tested public contract, controlled configuration, observable runtime, documented security boundary, versioned artifacts, and a tested rollback path. + +**What must remain explicit?** +The intended use, excluded use, data/credential handling, model or algorithm limitations, and which metrics are measured versus aspirational. + +**What should be completed next?** +Use the linked production-readiness issue for this repository as the checklist. Resolve missing tests, deployment instructions, observability, supply-chain controls, and release evidence before attaching a production claim. + + ## Architecture ```mermaid