Skip to content

Windows SDK Installation

📌 Requirements, Installation, and Setup

Requirements

To use the VecML Windows SDK, you need:

  • Windows 10/11 (64-bit)
  • Visual Studio 2022 (64-bit, Release mode)
  • C++17 or later

About License

Please contact sales@vecml.com to obtain a valid license.txt. The license file is required to initialize and use the VecML SDK. Without a valid license, functionalities are restricted or unavailable. Ensure that the license.txt file is placed in the correct directory and accessible by your application to avoid initialization errors.

📦 Installation

The SDK consists of:

  • fluffy_shared_lib.dll (Dynamic Library)
  • fluffy_shared_lib.lib (Import Library)
  • A set of header files (.h), including fluffy_interface.h

You need to integrate these files into your Visual Studio 2022 project.

Setup in Visual Studio 2022

Follow these steps to configure your project:

1️⃣ Create a New C++ Project

  • Open Visual Studio 2022
  • Select C++ Console Application or an empty C++ project
  • Set x64 as the build platform

2️⃣ Add Include Directories

  • Go to Project → Properties
  • Navigate to C/C++ → General → Additional Include Directories
  • Add the path where the SDK header files (.h) are located

3️⃣ Set Library Search Path

  • Go to Project → Properties
  • Navigate to Linker → General → Additional Library Directories
  • Add the path where fluffy_shared_lib.lib is located
  • Go to Linker → Input → Additional Dependencies
  • Add fluffy_shared_lib.lib

5️⃣ Enable OpenMP for Parallel Computing

VecML SDK can leverage OpenMP for parallel processing. To enable OpenMP in Visual Studio 2022: - Go to Project → Properties - Navigate to C/C++ → Language - Set OpenMP Support to Yes (/openmp)

6️⃣ Enable AVX2 for Optimized SIMD Instructions

For better performance on modern CPUs, enable Advanced Vector Extensions 2 (AVX2): - Go to Project → Properties - Navigate to C/C++ → Code Generation - Find Enable Enhanced Instruction Set - Select AVX2 (/arch:AVX2)

7️⃣ Enable Intrinsic Functions (/Oi)

Enabling intrinsic functions can improve performance by replacing function calls with inline machine instructions: - Go to Project → Properties - Navigate to C/C++ → Optimization - Set Enable Intrinsic Functions to Yes (/Oi)

8️⃣ Copy the DLL File

  • Place fluffy_shared_lib.dll in the same directory as your .exe file (inside the output folder, e.g., x64/Release/)

9️⃣ Include the Main Header in Your Code

To use all features of the SDK, include the following header:

#include "fluffy_interface.h" // vector database
#include "fluffy_document_interface.h" // document database

Now your project is set up, and you can start using the VecML Windows SDK for vector and document search operations. 🚀

For detailed SDK APIs:

Vector Database Documentation

Document Database Documentation