tinyvector
A tiny embedding database in pure Rust.
File Explorer
Download Latest Version (.zip)- build.yaml
- ci.yaml
- publish.yaml
- collection.rs
- docs.rs
- mod.rs
- system.rs
- db.rs
- errors.rs
- main.rs
- server.rs
- shutdown.rs
- similarity.rs
- .dockerignore
- .gitignore
- build.rs
- Cargo.lock
- Cargo.toml
- Dockerfile
- LICENSE
- README.md
- rustfmt.toml
# Installation Guide
1. Get the code
git clone https://github.com/m1guelpf/tinyvector
Downloads the entire project code from GitHub to your computer.
cd tinyvector
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run \
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)