Skip to content

Getting Started

Installation

pip install threading-cli

Initialize

cd your-project
threading init

Threading will:

  1. Scan — Detect notebooks, scripts, and data directories
  2. Resolve — Build complete dependency graph
  3. Profile — Find performance bottlenecks
  4. Optimize — Vectorize and parallelize hot paths
  5. Lock — Capture environment and provenance
[scan] Project layout detected
- notebooks/: 3 notebooks
- src/: preprocessing.py, pca.py, utils.py
- data/: raw, processed, metadata.tsv

[env] Resolving environment
- Found requirements.txt
- Undeclared deps: numpy, biopython, pydantic

[profile] Profiling notebooks & scripts
- 03_pca_analysis.ipynb
  • Cell 8 (PCA): 42.1s
  • Shape: ~30k samples × 8k features

[optimize] Targeted optimization
- Vectorizing PCA kernel
- GPU backend available (auto)

[lock] Hardening for reuse
- Capturing UV tree
- Emitting config/threading.yaml

[provenance] Capturing experiment lineage
- Code hash: src/pca.py@a13f9c
- Input data: counts_filtered.tsv (sha256)
✔ Workspace ready

Note

Threading never modifies your original files.

Generated files

your-project/
├── config/
│   ├── threading.yaml
│   └── params.yaml
├── .threading/
│   ├── workspace/
│   ├── provenance/
│   └── cache/
└── (your files unchanged)

Run locally

threading run

Next steps