knot-recognition 0.1.0

Knot recognition and Gauss/PD extraction from images.

Knot Recognition

Abstract

This project provides a scientific pipeline for knot recognition from images. It combines a ResNet-based CNN classifier with a structured, heuristic Gauss/PD extractor operating on skeletonized drawings. The repository is organized to support reproducible experiments, clear documentation, and future extensions.

Installation

pip install knot-recognition

Quickstart

knot --image /path/to/image.png --checkpoint ./checkpoints/best.pth --mapping mapping_example.csv

Optional symmetry-invariant feature extraction:

knot --image /path/to/image.png --checkpoint ./checkpoints/best.pth --mapping mapping_example.csv --features

Force a device:

knot --image /path/to/image.png --checkpoint ./checkpoints/best.pth --device cpu

knot-moves --image /path/to/image.png --overlay results/figures/moves_overlay.png

Diagram reducer + classifier (solver):

knot-solve --image /path/to/image.png --checkpoint ./checkpoints/best.pth --mapping mapping_example.csv

Training:

python -m knot_recognition.train --data-dir /path/to/data --outdir ./checkpoints --epochs 20 --batch 32 --lr 1e-3

Training on a specific device:

python -m knot_recognition.train --data-dir /path/to/data --device cuda

Protein Knot Pipeline (Stages 1–4)

Stage 1: Extract Cα backbones (KnotProt chains):

PYTHONPATH=./src python scripts/extract_knotprot_stage1.py \
  --pdb-dir data/knotprot/pdb \
  --out data/knotprot/backbones.npz \
  --manifest data/knotprot/backbones.csv

Stage 2: Projection + crossing detection

• sample_viewpoints, project_polyline, detect_crossings

Stage 3: Gauss code from crossings

• gauss_code_from_crossings

Stage 4: Hybrid ML classifier (projection image + Gauss embedding):

PYTHONPATH=./src python scripts/build_knotprot_hybrid_dataset.py \
  --viewpoints 32 --limit 20 --offset 0 --stride 3 --max-points 300 \
  --out data/knotprot/hybrid_dataset_part1.npz \
  --manifest data/knotprot/hybrid_manifest_part1.csv

PYTHONPATH=./src python scripts/merge_hybrid_parts.py \
  --out data/knotprot/hybrid_dataset.npz

python scripts/train_hybrid_classifier.py \
  --data data/knotprot/hybrid_dataset.npz \
  --out checkpoints/hybrid_classifier.pth \
  --epochs 2 --batch 64 --lr 1e-3

Project Structure

• src/knot_recognition/: Core Python package (models, dataset, preprocessing, inference, Gauss/PD extraction).
• docs/: Methods and reproducibility notes.
• notebooks/: Exploratory analysis and ablations.
• scripts/: Experiment drivers and automation helpers.
• data/: Reserved for datasets and processed artifacts.
• results/: Reserved for experiment outputs and figures.
• raw_knot/: Legacy dataset location (kept for compatibility).
• outputs/: Legacy outputs location (kept for compatibility).
• tests/: Synthetic tests for Gauss/PD extraction.

Data Format

Folder-structured dataset:

data_root/
  3_1/
  4_1/

Each subfolder is a class label and contains images.

Methods (Summary)

get_resnet(num_classes=1000, pretrained=True, model_name="resnet18", freeze_backbone=False)

• Skeleton graph -> spur pruning -> junction clustering -> graph simplification
• Edge pairing at crossings -> curve traversal -> PD construction
• Entry point: extract_gauss_code(skel, img_gray=None, cfg=None, return_debug=False)

Mapping CSV Schema

mapping_example.csv:

label,pd_code,gauss_code
3_1,"PD[ [1,2],[3,4] ]","1 -2 3"

Reproducibility

• Documented environment and workflow notes are in docs/reproducibility.md.
• Scientific documentation is in docs/scientific.md.
• Use a clean virtual environment and pinned versions for formal experiments.

Tests

pytest -q

Citation

See CITATION.cff for citation metadata.

Usage

See USAGE.md for end-to-end examples.

Known Limitations

• Chirality detection is heuristic and depends on how flips affect CNN confidence.
• Gauss/PD extractor assumes clean, high-contrast drawings.
• Over/under (sign) inference is not reliable from skeletons alone.