Skip to content

Commit 1ff85f2

Browse files
authored
Enhance README with badges and feature highlights
Updated README with badges and enhanced feature descriptions.
1 parent b9604f3 commit 1ff85f2

1 file changed

Lines changed: 22 additions & 6 deletions

File tree

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,32 @@
22

33
# Centered Kernel Alignment (CKA)
44

5-
**Fast, Memory-efficient, and Stable CKA Library for PyTorch**
5+
[![PyPI](https://img.shields.io/pypi/v/pytorch-cka.svg)](https://pypi.org/project/pytorch-cka/)
6+
[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://pypi.org/project/pytorch-cka/)
7+
[![CI](https://github.com/ryusudol/Centered-Kernel-Alignment/workflows/CI/badge.svg)](https://github.com/ryusudol/Centered-Kernel-Alignment/actions)
8+
9+
**Lightning-fast, Memory-efficient, and Numerically Stable CKA for PyTorch**
610

711
</div>
812

9-
## ✨ Key Features
1013

11-
- **Memory-efficient** — minibatch CKA without full-dataset loading
12-
- **Safe & automatic** — context manager handles hooks and cleanup
13-
- **Publication-ready plots** — heatmaps, trends, and comparison grids
14-
- **Production-ready** — HuggingFace, DataParallel/DDP, auto layer selection
14+
<p align="center">
15+
<img alt="A bar chart with benchmark results." src="docs/assets/bar-chart.png" width="100%" />
16+
</p>
17+
18+
<p align="center">
19+
<i>Computing CKA on two different ResNet-18 models.</i>
20+
</p>
21+
22+
23+
- ⚡️ **3000%** Faster than the [most popular CKA library](https://github.com/AntixK/PyTorch-Model-Compare)
24+
- 📦 Memory-efficient minibatch CKA computation
25+
- 🎨 Customizable visualizations: heatmaps and line charts
26+
- 🧠 Supports HuggingFace models, DataParallel, and DDP
27+
- 🐳 Installable via `pip` or `docker`
28+
- 🛠️ Modern `pyproject.toml` packaging
29+
- 🤝 Python 3.10–3.14 compatibility
30+
1531

1632
## 📦 Installation
1733

0 commit comments

Comments
 (0)