Neighborly is a versatile open-source vector database built with C#, designed to efficiently store and retrieve high-dimensional vector data. It offers two flexible deployment options: a gRPC API in a Docker container and a lightweight bundled library. With its cross-platform compatibility, Neighborly can be seamlessly integrated into a wide range of applications, including Windows, Xbox, iOS, macOS, Android, and Linux.
To use Neighborly as a web server, you can pull the Docker image from DockerHub:
docker pull nick206/neighborly:latest
Once the image is pulled, you can run the container using the following command:
docker run -p 8080:8080 -e PROTO_GRPC=true -e PROTO_REST=true nick206/neighborly:latest
This will start the Neighborly server, and you can access the gRPC API at localhost:8080.
To use Neighborly as a client library in your .NET projects, you can install the NuGet package using the following command:
PM> NuGet\Install-Package Neighborly
After installing the package, you can use the Neighborly client library in your code by importing the necessary namespaces:
using Neighborly;
using Neighborly.Databases;
Neighborly provides a gRPC API hosted in a Docker container, facilitating client-server architecture.
Neighborly can be used as a lightweight bundled library, similar to SQLite. Add a reference to the compiled DLL (or NuGet package) and utilize the provided classes and methods for managing vector data directly in your projects. The library can be seamlessly integrated into applications targeting Windows, Xbox, iOS, macOS, Android, and Linux platforms.
Neighborly offers a range of advanced search algorithms to efficiently query vector data:
We welcome contributions! If you have ideas for new features or have found bugs, please open an issue or submit a pull request. For major changes, please discuss them in an issue first.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or further assistance, feel free to contact .