Skip to content

Commit bb2e9b2

Browse files
committed
Use absolute URLs in README for PyPI compatibility
Relative links break when the README is rendered on pypi.org. Convert all image srcs, doc links, and LICENSE references to full GitHub URLs.
1 parent 112a023 commit bb2e9b2

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<p align="center">
2-
<img src="docs/images/logo.svg" alt="tensor-layouts" width="520">
2+
<img src="https://raw.githubusercontent.com/facebookresearch/tensor-layouts/main/docs/images/logo.svg" alt="tensor-layouts" width="520">
33
</p>
44

55
[![CI](https://github.com/facebookresearch/tensor-layouts/actions/workflows/ci.yml/badge.svg)](https://github.com/facebookresearch/tensor-layouts/actions/workflows/ci.yml)
66
[![PyPI](https://img.shields.io/pypi/v/tensor-layouts)](https://pypi.org/project/tensor-layouts/)
7-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/facebookresearch/tensor-layouts/blob/main/LICENSE)
88

99
A pure-Python implementation of the [NVIDIA CuTe](https://github.com/NVIDIA/cutlass/blob/main/media/docs/cute/00_quickstart.md) layout algebra. **No GPU required.**
1010

@@ -116,23 +116,23 @@ draw_swizzle(Layout((8, 8), (8, 1)), Swizzle(3, 0, 3), colorize=True)
116116
```
117117

118118
<p align="center">
119-
<img src="docs/images/row_major_8x8.png" alt="Row-Major 8x8 layout" width="400">
119+
<img src="https://raw.githubusercontent.com/facebookresearch/tensor-layouts/main/docs/images/row_major_8x8.png" alt="Row-Major 8x8 layout" width="400">
120120
</p>
121121

122122
<p align="center">
123-
<img src="docs/images/swizzle_8x8.png" alt="Swizzle(3, 0, 3) applied to row-major 8x8" width="800">
123+
<img src="https://raw.githubusercontent.com/facebookresearch/tensor-layouts/main/docs/images/swizzle_8x8.png" alt="Swizzle(3, 0, 3) applied to row-major 8x8" width="800">
124124
</p>
125125

126-
See [`examples/viz.ipynb`](examples/viz.ipynb) for a full
126+
See [`examples/viz.ipynb`](https://github.com/facebookresearch/tensor-layouts/blob/main/examples/viz.ipynb) for a full
127127
gallery of layout, swizzle, MMA atom, and tiled MMA visualizations.
128128

129129
## Documentation
130130

131-
- [Layout Algebra API](docs/layout_api.md) — construction, querying, compose, complement, divide, product
132-
- [Visualization API](docs/viz_api.md) — draw_layout, draw_swizzle, draw_mma_layout, and more
133-
- [Layout Examples](examples/layouts.py) — runnable script covering the full algebra (run from source checkout with `PYTHONPATH=src python3 examples/layouts.py`)
134-
- [Visualization Examples](examples/viz.py) — runnable script generating all visualization types (run from source checkout with `PYTHONPATH=src python3 examples/viz.py`)
135-
- [Visualization Notebook](examples/viz.ipynb) — Jupyter gallery
131+
- [Layout Algebra API](https://github.com/facebookresearch/tensor-layouts/blob/main/docs/layout_api.md) — construction, querying, compose, complement, divide, product
132+
- [Visualization API](https://github.com/facebookresearch/tensor-layouts/blob/main/docs/viz_api.md) — draw_layout, draw_swizzle, draw_mma_layout, and more
133+
- [Layout Examples](https://github.com/facebookresearch/tensor-layouts/blob/main/examples/layouts.py) — runnable script covering the full algebra (run from source checkout with `PYTHONPATH=src python3 examples/layouts.py`)
134+
- [Visualization Examples](https://github.com/facebookresearch/tensor-layouts/blob/main/examples/viz.py) — runnable script generating all visualization types (run from source checkout with `PYTHONPATH=src python3 examples/viz.py`)
135+
- [Visualization Notebook](https://github.com/facebookresearch/tensor-layouts/blob/main/examples/viz.ipynb) — Jupyter gallery
136136

137137
## Testing
138138

@@ -164,4 +164,4 @@ pytest tests/oracle_amd.py
164164

165165
## License
166166

167-
MIT License. See [LICENSE](LICENSE) for details.
167+
MIT License. See [LICENSE](https://github.com/facebookresearch/tensor-layouts/blob/main/LICENSE) for details.

0 commit comments

Comments
 (0)