Skip to content

Commit 85c77c9

Browse files
ingimclaude
andcommitted
chore: Remove redundant files, simplify README, fix CI for Python 3.14
- Remove test_legacy_python.py, test_llm_load.py, benchmark/plot.png - Add benchmark artifacts to .gitignore - Simplify README to install + features + doc links - Pin CI interpreters to 3.11-3.13 (PyO3 0.24 doesn't support 3.14) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 7b5a6b8 commit 85c77c9

6 files changed

Lines changed: 22 additions & 194 deletions

File tree

.github/workflows/CI.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
uses: PyO3/maturin-action@v1
4646
with:
4747
target: ${{ matrix.platform.target }}
48-
args: --release --out dist --find-interpreter
48+
args: --release --out dist --interpreter 3.11 3.12 3.13
4949
sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
5050
manylinux: auto
5151
- name: Upload wheels
@@ -76,7 +76,7 @@ jobs:
7676
uses: PyO3/maturin-action@v1
7777
with:
7878
target: ${{ matrix.platform.target }}
79-
args: --release --out dist --find-interpreter
79+
args: --release --out dist --interpreter 3.11 3.12 3.13
8080
sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
8181
manylinux: musllinux_1_2
8282
- name: Upload wheels
@@ -104,7 +104,7 @@ jobs:
104104
uses: PyO3/maturin-action@v1
105105
with:
106106
target: ${{ matrix.platform.target }}
107-
args: --release --out dist --find-interpreter
107+
args: --release --out dist --interpreter 3.11 3.12 3.13
108108
sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
109109
- name: Upload wheels
110110
uses: actions/upload-artifact@v4
@@ -128,7 +128,7 @@ jobs:
128128
uses: PyO3/maturin-action@v1
129129
with:
130130
target: ${{ matrix.platform.target }}
131-
args: --release --out dist --find-interpreter
131+
args: --release --out dist --interpreter 3.11 3.12 3.13
132132
sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
133133
- name: Upload wheels
134134
uses: actions/upload-artifact@v4

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ python/ztensor/ztensor/
4646

4747
*.tmp
4848
bench_out/
49+
benchmark/bench_out/
50+
benchmark/*.npz
51+
benchmark/*.png
52+
.pytest_cache/
4953

5054
# Docusaurus
5155
website/node_modules/

README.md

Lines changed: 14 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -4,78 +4,29 @@
44
[![PyPI](https://img.shields.io/pypi/v/ztensor.svg)](https://pypi.org/project/ztensor/)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66

7-
Simple tensor serialization format
8-
9-
## Key Features
10-
11-
- **Simple Spec** — Minimalist [spec](SPEC.md) for easy parsing.
12-
- **Zero-Copy Access** — Instant memory-mapping (mmap) with no extra RAM copying overhead.
13-
- **Efficient Writes** — Supports streaming and append-only operations without rewriting files.
14-
- **Future-Proof** — Decouples physical storage from logical representation for long-term compatibility.
15-
16-
## Tools
17-
18-
- **Rust Core** — High-performance, SIMD-aligned implementation.
19-
- **Python API** — First-class bindings for **NumPy** and **PyTorch**.
20-
- **Universal Converters** — CLI tools to convert **SafeTensors**, **GGUF**, **Pickle**, **NumPy (.npz)**, **ONNX**, and **HDF5** files.
21-
22-
## Comparison
23-
24-
| Feature | **zTensor** | SafeTensors | GGUF | Pickle | HDF5 |
25-
| :--- | :---: | :---: | :---: | :---: | :---: |
26-
| **Zero-Copy Read** ||||| ⚠️ |
27-
| **Safe (No Exec)** ||||||
28-
| **Streaming / Append** ||||||
29-
| **Sparse Tensors** ||||||
30-
| **Compression** ||||||
31-
| **Quantization** ||||||
32-
| **Parser Complexity** | 🟢 Low | 🟢 Low | 🟡 Med | 🔴 High | 🔴 High |
33-
34-
## Benchmark
35-
36-
![benchmark](benchmark/plot.png)
37-
38-
See [benchmark](benchmark/bench.py) for more details.
7+
A simple, safe tensor serialization format with zero-copy reads, streaming writes, and built-in compression.
398

409
## Installation
4110

42-
### Python
43-
4411
```bash
45-
pip install ztensor
12+
pip install ztensor # Python
13+
cargo add ztensor # Rust
14+
cargo install ztensor-cli # CLI
4615
```
4716

48-
See the [Python docs](https://pie-project.github.io/ztensor/python) for the full API reference.
49-
50-
### Rust
51-
52-
```toml
53-
[dependencies]
54-
ztensor = "1.2"
55-
```
56-
57-
See the [Rust docs](https://pie-project.github.io/ztensor/rust) or [docs.rs](https://docs.rs/ztensor) for the full API reference.
58-
59-
### CLI
60-
61-
```bash
62-
cargo install ztensor-cli
63-
```
64-
65-
See the [CLI docs](https://pie-project.github.io/ztensor/cli) for usage details.
66-
67-
## Supported Data Types
17+
## Features
6818

69-
| Type | Description |
70-
|------|-------------|
71-
| `float32`, `float16`, `bfloat16`, `float64` | Floating point |
72-
| `int8`, `int16`, `int32`, `int64` | Signed integers |
73-
| `uint8`, `uint16`, `uint32`, `uint64` | Unsigned integers |
74-
| `bool` | Boolean |
19+
- Zero-copy memory-mapped reads
20+
- Streaming, append-only writes
21+
- Zstd compression and checksums
22+
- Dense, sparse (CSR/COO), and quantized tensors
23+
- Convert from SafeTensors, GGUF, Pickle, NumPy, ONNX, and HDF5
7524

76-
## File Format
25+
## Documentation
7726

78-
See [SPEC.md](SPEC.md) for the complete specification.
27+
- [Website](https://pie-project.github.io/ztensor/) — guides, API reference, benchmarks
28+
- [Spec](SPEC.md) — file format specification
29+
- [docs.rs](https://docs.rs/ztensor) — Rust API docs
7930

8031
## License
8132

benchmark/plot.png

-339 KB
Binary file not shown.

test_legacy_python.py

Lines changed: 0 additions & 65 deletions
This file was deleted.

test_llm_load.py

Lines changed: 0 additions & 62 deletions
This file was deleted.

0 commit comments

Comments
 (0)