pycheck-neuron 1.0.3__tar.gz → 1.0.4__tar.gz

{pycheck_neuron-1.0.3 → pycheck_neuron-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycheck-neuron
-Version: 1.0.3
+Version: 1.0.4
 Summary: 33-rule static AST analyzer catching temporal lookahead bias, causal confusion, and uncertainty bugs in Python ML code. Zero dependencies.
 Author: NEURON Team
 Author-email: Fayo Ibrahim <fayo@neuron-lab.org>
@@ -105,7 +105,7 @@ PyCheck catches all three before execution:
 | Rule | What It Catches | Severity |
 |------|----------------|----------|
 | `T001` | `.shift(-1)` — accessing future data | **Error** |
-| `T002` | `train_test_split()` on time-series data | **Error** |
+| `T002` | `train_test_split()` on time-series data without chronological ordering | **Error** |
 | `T003` | `.rolling()` computed before the train/test split | Warning |
 | `T004` | `.expanding()` computed before split | Warning |
 | `T005` | `.pct_change(-1)` — future percent returns | **Error** |
@@ -121,7 +121,7 @@ PyCheck catches all three before execution:
 | `T015` | Negative `.shift()` inside `groupby().transform()` | **Error** |
 | `T016` | `pd.merge_asof()` with `direction='nearest'` or `'forward'` | **Error** |
 | `T017` | Target laundering & un-split target encoding (`regime_success_rate`) | **Error** |
-| `T018` | In-sample target encoding (`groupby().transform('mean')`, `TargetEncoder(cv=None)`) | **Error** |
+| `T018` | In-sample target encoding via `.transform()` or un-split group means | **Error** |
 
 ### Causal Confusion Rules (7 rules — `C001`–`C007`)
 
@@ -193,6 +193,30 @@ pycheck --list                 # List all 33 rules
 pycheck --help
 ```
 
+### Inline Rule Suppression
+
+PyCheck supports standard inline suppression comments with audit reason annotations:
+
+```python
+# Specific rule suppression
+df['target'] = df['close'].shift(-1)  # pycheck: ignore[T001]
+
+# Multi-rule suppression with audit justification
+signal = df[['close', 'target']].corr()  # pycheck: ignore[C001, C002] reason: exploratory EDA baseline
+
+# Blanket ignore or flake8-style noqa
+cv = KFold(n_splits=5, shuffle=True)  # pycheck: ignore
+X_tr = scaler.fit_transform(X)         # noqa: T010
+```
+
+Both same-line trailing comments and line-above comments are supported.
+
+### Sink-Gated Precision Engine
+
+To prevent false alarms during research and exploratory data analysis (EDA), PyCheck uses **AST sink-gating**:
+- Exploratory display calls like `df[['feature', 'target']].head()`, `.plot()`, `.describe()`, and `print(...)` are recognized as safe inspection and will **never** trigger feature leakage (`C002`).
+- The rule strictly guards actual modeling sinks (`X = ...`, `model.fit(...)`, `cross_validate(...)`).
+
 ### JSON Output (CI/CD Integration)
 
 ```bash
@@ -285,9 +309,9 @@ The `pycheck-vscode` extension gives you **real-time red/yellow squiggles** as y
 
 ---
 
-## Automated CI/CD Gatekeeping & Invariant Verification
+## PyCheck Cloud & Enterprise SaaS
 
-For quant teams, machine learning desks, and algorithmic trading funds, **PyCheck** provides continuous compliance and automated gatekeeping:
+For institutional hedge funds, algorithmic trading desks, and enterprise ML engineering teams, **PyCheck Cloud** provides continuous compliance and automated gatekeeping:
 
 * **Automated PR / MR Gatekeeping**: GitHub App & GitLab integration that automatically blocks pull requests containing temporal leaks, lookahead joins, or cross-fold contamination before they reach production.
 * **Proof-of-Causality Audit Certificates**: Cryptographically verifiable backtest audit reports (PDF & JSON) certifying that quantitative strategies and feature pipelines are provably free of temporal lookahead bias for LP allocators and risk committees.