README.md

NMSLIB-viz

📊 NMSLIB visualization tool

Installation

Install client via pip. Ideally, nmslib-viz is well supported for Python >= 3.7.

pip3 install nmslib-viz --no-binary nmslib

The --no-binary option is important for a better CPU performance.

Usage

Just run it like this:

nmslib-viz INDEX_FILE_PATH [--number_points NUMBER_POINTS]

Arguments:

• INDEX_FILE_PATH: String pointing to the NMSLIB file path. There has to be the additional .dat file for the index, the one that is created when uses the save_data=True option in the saveIndex() function. For example: index.nmslib and index.nmslib.dat need to exist but only index.nmslib has to be provided as this parameter.
• NUMBER_POINTS: (optional) Number of points as a maximum to plot from the NMSLIB index data, where has to be 1 at least. Default value: 1000.

You could also check this example for knowing how to use this library in a Python script.

Result

Note: this example is a representation of the SearchLy index.

Development

Recommendations

Usage of virtualenv is recommended for package library / runtime isolation.

Installation

1. Setup virtual environment

2. Install dependencies

pip3 install -r requirements.lock

3. Install locally

pip3 install . --no-binary nmslib

Contributing

Suggestions, improvements, and enhancements are always welcome! If you have any issues, please do raise one in the Issues section. If you have an improvement, do file an issue to discuss the suggestion before creating a PR.

All ideas – no matter how outrageous – welcome!

Authors

• Albert Suàrez

License

Apache-2.0 © nmslib-viz