Skip to content

Commit 71abeba

Browse files
committed
update development documentation
1 parent b7f8aeb commit 71abeba

File tree

3 files changed

+14
-9
lines changed

3 files changed

+14
-9
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "valentinus"
3-
version = "1.1.2"
3+
version = "1.1.3"
44
edition = "2024"
55
authors = ["Nigel Christian <nigel.christian@hiahatf.org>"]
66
documentation = "https://docs.rs/valentinus"

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ A thread-safe vector database for model inference inside LMDB.
1616

1717
### getting started
1818

19+
NOTE: ensure you have the development packages below (e.g. for Fedora)
20+
* `sudo dnf install openssl-devel`
21+
* `sudo dnf install gcc-c++`
22+
1923
```bash
2024
git clone https://github.com/kn0sys/valentinus && cd valentinus
2125
```
@@ -37,13 +41,14 @@ git clone https://github.com/kn0sys/valentinus && cd valentinus
3741
* Get the model.onnx and tokenizer.json from huggingface or [build them](https://huggingface.co/docs/optimum/en/exporters/onnx/usage_guides/export_a_model)
3842

3943
```bash
40-
mkdir all-MiniLM-L6-v2_onnx
41-
cd all-MiniLM-L6-v2_onnx && wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/config.json
42-
wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/onnx/model.onnx
43-
wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/special_tokens_map.json
44-
wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/tokenizer_config.json
45-
wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/tokenizer.json
46-
wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/vocab.txt
44+
mkdir all-MiniLM-L6-v2_onnx \
45+
&& cd all-MiniLM-L6-v2_onnx \
46+
&& wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/config.json \
47+
&& wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/onnx/model.onnx \
48+
&& wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/special_tokens_map.json \
49+
&& wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/tokenizer_config.json \
50+
&& wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/tokenizer.json \
51+
&& wget https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/main/vocab.txt
4752
```
4853

4954
`cargo test`

0 commit comments

Comments
 (0)