vec-embed-store 0.3.2

This is a thin wrapper around LanceDb (VectorDb) meant to provide a means to create/store/query embeddings in a LanceDb without the need to grok the lower level Arrow/ColumnarDb tech.
Documentation

Build #1286573 2024-07-09 20:28:28

# rustc version rustc 1.81.0-nightly (35b658fb1 2024-07-08)

# docs.rs version docsrs 0.6.0 (55314a20 2024-07-09)

# build log [INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/vec-embed-store-0.3.2/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/vec-embed-store-0.3.2/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "6442450944" "--cpus" "6" "--user" "1001:1001" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:dff56e7819e73ed36160586b3445e93eb0be776c16704aeeded9c3fb668b2384" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20240708-1.81.0-nightly-35b658fb1\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }` [INFO] [stdout] 299be5aae721d4a2cbcb2d411f1445243fd3e63671ceab8116e7ba4c44eda341 [INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap. [INFO] running `Command { std: "docker" "start" "-a" "299be5aae721d4a2cbcb2d411f1445243fd3e63671ceab8116e7ba4c44eda341", kill_on_drop: false }` [INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op [INFO] [stderr] Documenting vec-embed-store v0.3.2 (/opt/rustwide/workdir) [INFO] [stderr] warning: missing documentation for a struct field [INFO] [stderr] --> src/lib.rs:172:5 [INFO] [stderr] | [INFO] [stderr] 172 | pub id: String, [INFO] [stderr] | ^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] note: the lint level is defined here [INFO] [stderr] --> src/lib.rs:12:58 [INFO] [stderr] | [INFO] [stderr] 12 | #![warn(missing_debug_implementations, rust_2018_idioms, missing_docs)] [INFO] [stderr] | ^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct field [INFO] [stderr] --> src/lib.rs:173:5 [INFO] [stderr] | [INFO] [stderr] 173 | pub text: String, [INFO] [stderr] | ^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct field [INFO] [stderr] --> src/lib.rs:179:5 [INFO] [stderr] | [INFO] [stderr] 179 | pub id: String, [INFO] [stderr] | ^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct field [INFO] [stderr] --> src/lib.rs:180:5 [INFO] [stderr] | [INFO] [stderr] 180 | pub text: String, [INFO] [stderr] | ^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct field [INFO] [stderr] --> src/lib.rs:182:5 [INFO] [stderr] | [INFO] [stderr] 182 | pub distance: f32, [INFO] [stderr] | ^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct field [INFO] [stderr] --> src/lib.rs:188:5 [INFO] [stderr] | [INFO] [stderr] 188 | pub model_name: EmbeddingModel, [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct field [INFO] [stderr] --> src/lib.rs:191:5 [INFO] [stderr] | [INFO] [stderr] 191 | pub cache_dir: PathBuf, [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct field [INFO] [stderr] --> src/lib.rs:192:5 [INFO] [stderr] | [INFO] [stderr] 192 | pub show_download_progress: bool, [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an enum [INFO] [stderr] --> src/lib.rs:570:1 [INFO] [stderr] | [INFO] [stderr] 570 | pub enum EmbedDbError { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/lib.rs:572:5 [INFO] [stderr] | [INFO] [stderr] 572 | EmbeddingsEngine(#[from] anyhow::Error), [INFO] [stderr] | ^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/lib.rs:574:5 [INFO] [stderr] | [INFO] [stderr] 574 | VectorDbEngine(#[from] lancedb::Error), [INFO] [stderr] | ^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/lib.rs:576:5 [INFO] [stderr] | [INFO] [stderr] 576 | SerDe(#[from] serde_arrow::Error), [INFO] [stderr] | ^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/lib.rs:578:5 [INFO] [stderr] | [INFO] [stderr] 578 | Arrow(#[from] ArrowError), [INFO] [stderr] | ^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/lib.rs:580:5 [INFO] [stderr] | [INFO] [stderr] 580 | Config(String), [INFO] [stderr] | ^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/lib.rs:582:5 [INFO] [stderr] | [INFO] [stderr] 582 | InvalidState(String), [INFO] [stderr] | ^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: Rust code block is empty [INFO] [stderr] --> src/lib.rs:137:9 [INFO] [stderr] | [INFO] [stderr] 137 | /// ``` [INFO] [stderr] | ^^^ [INFO] [stderr] | [INFO] [stderr] = note: `#[warn(rustdoc::invalid_rust_codeblocks)]` on by default [INFO] [stderr] help: mark blocks that do not contain Rust code as text [INFO] [stderr] | [INFO] [stderr] 137 | /// ```text [INFO] [stderr] | ++++ [INFO] [stderr] [INFO] [stderr] warning: `vec-embed-store` (lib doc) generated 16 warnings (run `cargo fix --lib -p vec-embed-store` to apply 1 suggestion) [INFO] [stderr] Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.99s [INFO] [stderr] Generated /opt/rustwide/target/x86_64-unknown-linux-gnu/doc/vec_embed_store/index.html [INFO] running `Command { std: "docker" "inspect" "299be5aae721d4a2cbcb2d411f1445243fd3e63671ceab8116e7ba4c44eda341", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "299be5aae721d4a2cbcb2d411f1445243fd3e63671ceab8116e7ba4c44eda341", kill_on_drop: false }` [INFO] [stdout] 299be5aae721d4a2cbcb2d411f1445243fd3e63671ceab8116e7ba4c44eda341