Skip to content

Commit 9bc7a4a

Browse files
authored
Update README.md
1 parent cbb0d7d commit 9bc7a4a

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
1-
# AI-bench
2-
Unified AI performance benchmarking suite.
1+
# AI-bench: Unified AI Benchmarking Suite
2+
[![Tests](https://github.com/libxsmm/AI-bench/actions/workflows/test.yml/badge.svg)](https://github.com/libxsmm/AI-bench/actions/workflows/test.yml)
3+
[![Lint](https://github.com/libxsmm/AI-bench/actions/workflows/lint.yml/badge.svg)](https://github.com/libxsmm/AI-bench/actions/workflows/lint.yml)
4+
5+
## Installation
6+
The project is using [uv](https://docs.astral.sh/uv/) package manager.
7+
8+
`uv` can be [installed](https://docs.astral.sh/uv/getting-started/installation/) locally using:
9+
```bash
10+
pip install uv
11+
```
12+
13+
The project can be installed with appropriate device-specific extensions using:
14+
```bash
15+
# CPU only
16+
uv sync --extra cpu
17+
# CPU + XPU
18+
uv sync --extra xpu
19+
```
20+
21+
## Linting
22+
The project uses `pre-commit` to run various checks automatically.
23+
All checks can be run using:
24+
```bash
25+
pre-commit run -a
26+
```

0 commit comments

Comments
 (0)