zer-prof 1.1.0

Host-side NVTX profiling annotations for zer, trace! and trace_cuda! macros with zero-cost no-op fallback
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# zer-prof

Host-side NVTX profiling annotations for the zer entity-resolution library.

Provides `trace!`, `trace_cuda!`, and `trace_vulkan!` macros that wrap code blocks with RAII NVTX ranges visible in **Nsight Systems** (`nsys`). All macros are zero-cost no-ops when no feature flag is enabled.

- **Documentation**: [docs.zal-analytics.ch](https://docs.zal-analytics.ch)
- **Website**: [www.zal-analytics.ch](https://www.zal-analytics.ch)
- **Support & feedback**: [info@zal-analytics.ch](mailto:info@zal-analytics.ch)

## Feature flags

| Flag      | Effect |
|-----------|--------|
| `cuda`    | Activates NVTX; `trace_cuda!` emits named ranges |
| `vulkan`  | Activates NVTX; `trace_vulkan!` emits named ranges |
| `avx2`    | Activates NVTX for AVX2 SIMD profiling |
| `cpu`     | Activates NVTX for CPU-path profiling |
| `nvtx`    | Standalone NVTX activation, no compute backend |
| *(none)*  | All macros expand to bare blocks, zero overhead |

## Usage

```rust
zer_prof::init(); // call once in main()

let result = zer_prof::trace!("compare_batch", {
    comparator.compare_batch(&pairs, &schema)
});
```

Filter by CUDA regions in Nsight Compute:
```bash
ncu --nvtx --nvtx-include "regex:^CUDA:.*" ./your_binary
```

## License

Apache-2.0 ยท [GitHub](https://github.com/ZAL-Analytics/zer)