Skip to content

Commit 6ffcbb7

Browse files
quantbaiclaude
andcommitted
docs: remove Numerical Conventions from README
Move technical detail out of the landing page. README now flows: logo -> one-liner -> abstractions -> install -> usage -> operators -> links. Numerical conventions remain in OPERATORS.md for users who need them. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent badd468 commit 6ffcbb7

1 file changed

Lines changed: 2 additions & 13 deletions

File tree

README.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,6 @@ Polars-native factor computation engine for quantitative research. All operators
1717
- **`Panel`** -- Balanced `(timestamp, symbol)` container with strict alignment guarantees. Prevents look-ahead bias by construction.
1818
- **`Factor`** -- Immutable signal vector. Every operator takes `Factor` and returns `Factor` with eager evaluation.
1919

20-
## Numerical Conventions
21-
22-
| Convention | Summary |
23-
| --- | --- |
24-
| Null semantics | NaN/Inf unified to null on construction. Single missing-value type throughout. |
25-
| Division by zero | All divisions guarded at `abs(denom) < 1e-10`, returning null. |
26-
| Rank range | (0, 1] -- does not pass through zero. Ties use `average` method. |
27-
| Std/Variance/Covariance | ddof=0 (population). Correlation is ddof-invariant. |
28-
| Rolling warmup | All `ts_*` operators: first `window-1` values are null. |
29-
30-
Full conventions and per-operator specifications:
31-
**[OPERATORS.md](OPERATORS.md)**
32-
3320
## Installation
3421

3522
```bash
@@ -80,6 +67,8 @@ panel = load("hourly.parquet", interval="1h")
8067

8168
`add` `subtract` `multiply` `divide` `reverse` `densify` `bucket` and standard operators (`+` `-` `*` `/` `**` `abs`)
8269

70+
Full specifications and numerical conventions: **[OPERATORS.md](OPERATORS.md)**
71+
8372
## Development
8473

8574
```bash

0 commit comments

Comments
 (0)