Upload folder using huggingface_hub

.gitattributes

@@ -1,59 +1 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.lz4 filter=lfs diff=lfs merge=lfs -text
-*.mds filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text
-# Audio files - uncompressed
-*.pcm filter=lfs diff=lfs merge=lfs -text
-*.sam filter=lfs diff=lfs merge=lfs -text
-*.raw filter=lfs diff=lfs merge=lfs -text
-# Audio files - compressed
-*.aac filter=lfs diff=lfs merge=lfs -text
-*.flac filter=lfs diff=lfs merge=lfs -text
-*.mp3 filter=lfs diff=lfs merge=lfs -text
-*.ogg filter=lfs diff=lfs merge=lfs -text
-*.wav filter=lfs diff=lfs merge=lfs -text
-# Image files - uncompressed
-*.bmp filter=lfs diff=lfs merge=lfs -text
-*.gif filter=lfs diff=lfs merge=lfs -text
-*.png filter=lfs diff=lfs merge=lfs -text
-*.tiff filter=lfs diff=lfs merge=lfs -text
-# Image files - compressed
-*.jpg filter=lfs diff=lfs merge=lfs -text
-*.jpeg filter=lfs diff=lfs merge=lfs -text
-*.webp filter=lfs diff=lfs merge=lfs -text
-# Video files - compressed
-*.mp4 filter=lfs diff=lfs merge=lfs -text
-*.webm filter=lfs diff=lfs merge=lfs -text
+data/*.parquet filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,4 @@
+raw/
+__pycache__/
+*.pyc
+.DS_Store

LICENSE

@@ -0,0 +1,23 @@
+# LICENSE (MIT)
+
+MIT License
+
+Copyright (c) 2025 Lakshay Chhabra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,3 +1,83 @@
----
-license: mit
----
+# FinLucRAG Corpus (OHLCV + SEC/PR Index)
+
+One-stop **corpus metadata** for building finance RAG systems.  
+This repo ships **two Parquet tables** and a **fetcher**. It does **not** re-host filings/press releases.
+
+## What’s included
+- `data/ohlcv.parquet` — daily OHLCV for ~30 tickers (2022-01-01 → 2025-09-05).
+- `data/filings.parquet` — document-level index of SEC filings & earnings press releases:
+  doc IDs/keys, statement dates, EDGAR **doc URLs** (stable, file-specific), checksums, and basic classification.
+- `scripts/fetch_raw.py` — polite downloader that saves originals to `raw/{doc_key}`.
+
+## What’s *not* included
+- No raw HTML/PDF (legal/size reasons). Fetch on demand with the script.
+- No paragraph splits (that’s on the user and their workflow).
+- No benchmark Q&A (that will live in a separate benchmark repo).
+
+---
+
+## File layout
+data/
+ohlcv.parquet
+filings.parquet
+scripts/
+fetch_raw.py
+
+
+## Schemas (frozen)
+
+### `data/ohlcv.parquet`
+| column | type | notes |
+|---|---|---|
+| `date` | date | trading day (UTC) |
+| `ticker` | string (UPPER) | e.g., AAPL |
+| `open, high, low, close` | float64 | |
+| `volume` | int64 | |
+
+### `data/filings.parquet`
+| column | type | notes |
+|---|---|---|
+| `doc_id` | string | `{ticker}_{accession}_{filename}` |
+| `doc_key` | string | `{ticker}/{accession}/{source}/{filename}` |
+| `doc_local_hint` | string | `raw/{doc_key}` target path |
+| `ticker` | string | |
+| `cik` | string | zero-padded |
+| `cik_int` | int | numeric CIK |
+| `accession` | string | with dashes |
+| `acc_nodash` | string | digits only |
+| `form` | string | `8-K`, `10-Q`, `10-K`, … |
+| `source` | enum | `primary`, `press_release`, `exhibits` |
+| `statement_date` | date | doc day (PR/filing) |
+| `event_date` | date | same as `statement_date` |
+| `next_trading_hint` | date | `event_date + 1 day` (convenience) |
+| `event_type` | enum | `earnings` or `other` (heuristic: 8-K Item `2.02` / EX-99.* PR text) |
+| `item_codes` | string/NA | e.g., `2.02,9.01` for 8-K |
+| `doc_code` | string/NA | e.g., `EX-99.1` |
+| `title` | string/NA | if known |
+| `url` | string | **doc-level** EDGAR URL (ends with `filename`) |
+| `content_type` | string | `text/html`, `application/pdf`, `text/plain` |
+| `byte_len` | int | size when indexed |
+| `sha256` | string | checksum of local copy at index time |
+| `filename` | string | file name |
+
+---
+
+## Quick start
+
+### Load with pandas
+```python
+import pandas as pd
+ohlcv = pd.read_parquet("data/ohlcv.parquet")
+fil   = pd.read_parquet("data/filings.parquet")
+print(len(ohlcv), len(fil))
+```
+# Fetch originals (on your machine)
+```python
+python scripts/fetch_raw.py \
+  --parquet data/filings.parquet \
+  --out raw \
+  --only event_type=earnings \
+  --sources press_release,primary \
+  --rate 2 --verify-sha
+# Files land under: raw/{doc_key}
+```

data/filings.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:86d6a40d5221b4b1affb04b50f7f6ec7d0e42a87927988bc43126e00c94e6757
+size 273409

data/ohlcv.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:be532515f2cff1543ca49410eb73f9785f4bab35641b99ed4f88386b0a3a4e9a
+size 592117

scripts/fetch_raw.py

@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+"""
+Fetch raw documents listed in data/filings.parquet to raw/{doc_key}.
+- Respects SEC by default: 2 requests/second, retries, proper User-Agent.
+- Skips existing files unless --overwrite. Can verify sha256 if present.
+
+Usage:
+  python scripts/fetch_raw.py --parquet data/filings.parquet --out raw --only event_type=earnings --sources press_release,primary --rate 2 --max 100 --verify-sha
+"""
+
+import argparse, os, time, re, sys, hashlib
+from pathlib import Path
+import pandas as pd
+import requests
+from requests.adapters import HTTPAdapter, Retry
+
+def sha256_file(p: Path, chunk=1<<20):
+    h = hashlib.sha256()
+    with p.open("rb") as f:
+        for b in iter(lambda: f.read(chunk), b""):
+            h.update(b)
+    return h.hexdigest()
+
+def parse_kv_filters(s: str):
+    # "k1=v1,k2=v2" -> dict
+    out = {}
+    if not s:
+        return out
+    for part in s.split(","):
+        if "=" not in part:
+            continue
+        k, v = part.split("=", 1)
+        out[k.strip()] = v.strip()
+    return out
+
+def main():
+    ap = argparse.ArgumentParser()
+    ap.add_argument("--parquet", default="data/filings.parquet")
+    ap.add_argument("--out", default="raw")
+    ap.add_argument("--tickers", default="", help="Comma list, e.g. AAPL,MSFT")
+    ap.add_argument("--sources", default="", help="Comma list, e.g. press_release,primary,exhibits")
+    ap.add_argument("--only", default="", help="Comma key=val filters, e.g. event_type=earnings,form=8-K")
+    ap.add_argument("--max", type=int, default=0, help="Cap downloads (0 = no cap)")
+    ap.add_argument("--overwrite", action="store_true", help="Re-download even if file exists")
+    ap.add_argument("--verify-sha", action="store_true", help="Verify against parquet sha256 when available")
+    ap.add_argument("--rate", type=float, default=2.0, help="Requests per second (float). Default 2.0")
+    ap.add_argument("--timeout", type=float, default=40.0, help="HTTP timeout seconds")
+    ap.add_argument("--user-agent", default="FinLucRAG/1.0 (+contact: YOUR_EMAIL@EXAMPLE.COM)",
+                    help="Set a real contact email here before heavy usage.")
+    ap.add_argument("--dry-run", action="store_true")
+    args = ap.parse_args()
+
+    outdir = Path(args.out)
+    outdir.mkdir(parents=True, exist_ok=True)
+
+    df = pd.read_parquet(args.parquet)
+
+    # Basic filtering
+    if args.tickers:
+        tickers = set([t.strip().upper() for t in args.tickers.split(",") if t.strip()])
+        df = df[df["ticker"].str.upper().isin(tickers)]
+    if args.sources:
+        srcs = set([s.strip() for s in args.sources.split(",") if s.strip()])
+        df = df[df["source"].isin(srcs)]
+    kv = parse_kv_filters(args.only)
+    for k, v in kv.items():
+        if k not in df.columns:
+            print(f"[WARN] filter key '{k}' not in columns; ignoring")
+            continue
+        df = df[df[k].astype(str) == v]
+
+    # Sort by event_date then source
+    if "event_date" in df.columns:
+        df = df.sort_values(["event_date", "ticker", "source"])
+    else:
+        df = df.sort_values(["statement_date", "ticker", "source"])
+
+    # Session with retries
+    sess = requests.Session()
+    retries = Retry(total=5, backoff_factor=0.5, status_forcelist=(429, 500, 502, 503, 504))
+    sess.mount("https://", HTTPAdapter(max_retries=retries))
+    sess.headers.update({
+        "User-Agent": args.user_agent,
+        "Accept": "*/*",
+        "Connection": "keep-alive",
+    })
+
+    per_req_delay = 1.0 / max(args.rate, 0.001)
+    done = 0
+
+    for _, row in df.iterrows():
+        url = row["url"]
+        doc_key = row.get("doc_key")
+        filename = row.get("filename")
+        if not doc_key or not filename:
+            print(f"[SKIP] missing doc_key/filename for {row.get('doc_id')}")
+            continue
+
+        dest = outdir / doc_key
+        dest.parent.mkdir(parents=True, exist_ok=True)
+
+        if dest.exists() and not args.overwrite:
+            if args.verify_sha and isinstance(row.get("sha256"), str) and row["sha256"]:
+                cur = sha256_file(dest)
+                if cur == row["sha256"]:
+                    print(f"[OK] exists+verified {dest}")
+                    pass
+                else:
+                    print(f"[WARN] hash mismatch for {dest}; redownloading")
+                    dest.unlink(missing_ok=True)
+            else:
+                print(f"[SKIP] exists {dest}")
+                continue
+
+        if args.dry_run:
+            print(f"[DRY] would fetch -> {url} -> {dest}")
+            done += 1
+            if args.max and done >= args.max:
+                break
+            continue
+
+        try:
+            resp = sess.get(url, timeout=args.timeout, stream=True)
+            resp.raise_for_status()
+            tmp = dest.with_suffix(dest.suffix + ".part")
+            with tmp.open("wb") as f:
+                for chunk in resp.iter_content(chunk_size=1<<16):
+                    if chunk:
+                        f.write(chunk)
+            if args.verify_sha and isinstance(row.get("sha256"), str) and row["sha256"]:
+                cur = sha256_file(tmp)
+                if cur != row["sha256"]:
+                    tmp.unlink(missing_ok=True)
+                    print(f"[FAIL] sha256 mismatch for {dest.name} (expected {row['sha256']}, got {cur})")
+                    time.sleep(per_req_delay)
+                    continue
+            tmp.rename(dest)
+            print(f"[OK] {url} -> {dest}")
+            done += 1
+            if args.max and done >= args.max:
+                break
+            time.sleep(per_req_delay)
+        except requests.RequestException as e:
+            print(f"[ERR] {url} -> {e}")
+            time.sleep(per_req_delay)
+            continue
+
+    print(f"[DONE] fetched={done}")
+
+if __name__ == "__main__":
+    main()