Merge pull request #2 from eugenehp/git-patches

Create git patches for submodules

Cargo.toml

@@ -6,10 +6,10 @@ members = [
 ]
 
 [workspace.dependencies]
-thiserror = "1"
+thiserror = "2.0.3"
 tracing = "0.1"
 bindgen = "0.70.1"
-cc = "1.1.31"
+cc = "1.2.1"
 encoding_rs = "0.8.34"
 
 [workspace.lints.rust]

README.md

@@ -4,36 +4,25 @@ Almost safe wrapper for [BitNet-cpp](https://github.com/microsoft/BitNet) based
 
 ## Development
 
-Add bitnet submodule:
-
-```shell
-cd bitnet-cpp-sys
-git submodule add --name bitnet --depth 10 -- https://github.com/microsoft/BitNet.git bitnet 
-```
-
-Pull recursive updates:
-
-```shell
-cd bitnet-cpp-sys/bitnet
-git submodule update --init --recursive
-```
-
-Configure using python:
-
-```shell
-cd bitnet-cpp-sys/bitnet
-pip install -r requirements.txt
-python setup_env.py --hf-repo HF1BitLLM/Llama3-8B-1.58-100B-tokens -q i2_s # only needs gen_code() 
-```
+See [bitnet-cpp-sys](https://github.com/eugenehp/bitnet-cpp-rs/tree/main/bitnet-cpp-sys)
 
 ## Roadmap
 
 - [ ] minimize crate size
-- [ ] rewrite sampler [PR 9294](https://github.com/ggerganov/llama.cpp/pull/9294)
+- [x] rewrite sampler [PR 9294](https://github.com/ggerganov/llama.cpp/pull/9294)
 - [ ] look into Metal implementation of MatMul kernerls for BitNet
 - [ ] add more examples
 - [ ] replace all remaining python from BitNet repo
 - [ ] add better division between `arm64` and `x86_64`
+- [ ] move python code generation into `patch` files
+
+## Platform support
+
+| arm64 | x64 | OS | comments |
+|---|---|---|---|
+| ✅ | ❌ | MacOS | tested fully on Apple Silicon macs | 
+| ⚠️ | ❌ | Linux | should test on ARM based linux | 
+| ❓ | ❌ | Windows | we're using patches, so *-sys build won't work yet | 
 
 ## Thanks