sfbinpack 0.2.0

Library to read Stockfish Binpacks
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# Stockfish Binpack

Rust port of the Stockfish binpack reader from the [C++ version](https://github.com/official-stockfish/Stockfish/blob/tools/src/extra/nnue_data_binpack_format.h).

## Compile

If your machine has the fast BMI2 instruction set (Zen 3+), you should enable the feature flag

```bash
cargo build --release --features bmi2;
```

or define it in your `Cargo.toml` file (change version).

```
[dependencies]
binpack = { version = "0.1.0", features = ["bmi2"] }
```

## Usage

```rust
use sfbinpack::reader::data_reader::CompressedTrainingDataEntryReader;

fn main() {
    let mut reader = CompressedTrainingDataEntryReader::new(
        "test60-2019-2tb7p.min.high-simple-eval-1k.min-v2.binpack", // path to file
    )
    .unwrap();

    while reader.has_next() {
        let entry = reader.next();

        println!("entry:");
        println!("fen {}", entry.pos.fen());
        println!("uci {:?}", entry.mv.as_uci());
        println!("score {}", entry.score);
        println!("ply {}", entry.ply);
        println!("result {}", entry.result);
        println!("\n");

        // progress percentage
        // let percentage = reader.read_bytes() as f64 / reader.file_size() as f64 * 100.0;
    }
}
```

*If you are doing some counting keep in mind to use a `u64` type for the counter.*

## Performance Comparison

Slightly faster when compiled with bmi2 because of _pdep_u64 trick which is missing in the upstream version.

## License

GNU General Public License v3.0

<https://www.gnu.org/licenses/gpl-3.0.html>