You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Some early staging for README updates and pyproject updates for a 0.6.0 release for diskannpy.
* Trying to fix the CI badge to point toward main's latest build
* Updating documentation for pdoc generation
* Documentation updates. Tightened up the API to drop list support (there were entirely too many cases where it wouldn't work, and it's easier to just tell people to convert it themselves)
* Some module reorganization to make pdoc actually display the docstrings for variables re-exported at the top level
* A copy paste happened that shouldn't have.
* Updating the apps to use the new 0.6.0 api
* Addressing PR feedback
* Some of the documentation changes didn't get made in both from_file or the constructor
DiskANN is a suite of scalable, accurate and cost-effective approximate nearest neighbor search algorithms for large-scale vector search that support real-time changes and simple filters.
6
12
This code is based on ideas from the [DiskANN](https://papers.nips.cc/paper/9527-rand-nsg-fast-accurate-billion-point-nearest-neighbor-search-on-a-single-node.pdf), [Fresh-DiskANN](https://arxiv.org/abs/2105.09613) and the [Filtered-DiskANN](https://harsha-simhadri.org/pubs/Filtered-DiskANN23.pdf) papers with further improvements.
* This will also build gperftools submodule for libtcmalloc_minimal dependency.
86
+
87
+
* This will also build gperftools submodule for libtcmalloc_minimal dependency.
80
88
* Generated binaries are stored in the x64/Release or x64/Debug directories.
81
89
82
90
## Usage:
@@ -88,16 +96,16 @@ Please see the following pages on using the compiled code:
88
96
-[Commandline examples for using in-memory streaming indices](workflows/dynamic_index.md)
89
97
-[Commandline interface for building and search in memory indices with label data and filters](workflows/filtered_in_memory.md)
90
98
-[Commandline interface for building and search SSD based indices with label data and filters](workflows/filtered_ssd_index.md)
91
-
-To be added: Python interfaces and docker files
99
+
-[diskannpy - DiskANN as a python extension module](python/README.md)
92
100
93
101
Please cite this software in your work as:
94
102
95
103
```
96
104
@misc{diskann-github,
97
-
author = {Simhadri, Harsha Vardhan and Krishnaswamy, Ravishankar and Srinivasa, Gopal and Subramanya, Suhas Jayaram and Antonijevic, Andrija and Pryce, Dax and Kaczynski, David and Williams, Shane and Gollapudi, Siddarth and Sivashankar, Varun and Karia, Neel and Singh, Aditi and Jaiswal, Shikhar and Mahapatro, Neelam and Adams, Philip and Tower, Bryan}},
105
+
author = {Simhadri, Harsha Vardhan and Krishnaswamy, Ravishankar and Srinivasa, Gopal and Subramanya, Suhas Jayaram and Antonijevic, Andrija and Pryce, Dax and Kaczynski, David and Williams, Shane and Gollapudi, Siddarth and Sivashankar, Varun and Karia, Neel and Singh, Aditi and Jaiswal, Shikhar and Mahapatro, Neelam and Adams, Philip and Tower, Bryan and Patel, Yash}},
98
106
title = {{DiskANN: Graph-structured Indices for Scalable, Fast, Fresh and Filtered Approximate Nearest Neighbor Search}},
Packages published to PyPI will always be built using the latest numpy major.minor release (at this time, 1.25).
5
13
6
-
Conda distributions for versions 1.19-1.25 will be completed as a future effort. In the meantime, feel free to
14
+
Conda distributions for versions 1.19-1.25 will be completed as a future effort. In the meantime, feel free to
7
15
clone this repository and build it yourself.
8
16
9
17
## Local Build Instructions
@@ -16,11 +24,18 @@ build `diskannpy` with these additional instructions.
16
24
In the root folder of DiskANN, there is a file `pyproject.toml`. You will need to edit the version of numpy in both the
17
25
`[build-system.requires]` section, as well as the `[project.dependencies]` section. The version numbers must match.
18
26
27
+
#### Linux
19
28
```bash
20
-
python3.11 -m venv venv # versions from python3.8 and up should work. on windows, you might need to use py -3.11 -m venv venv
21
-
source venv/bin/activate # linux
22
-
# or
23
-
venv\Scripts\Activate.{ps1, bat} # windows
29
+
python3.11 -m venv venv # versions from python3.9 and up should work
30
+
source venv/bin/activate
31
+
pip install build
32
+
python -m build
33
+
```
34
+
35
+
#### Windows
36
+
```powershell
37
+
py -3.11 -m venv venv # versions from python3.9 and up should work
38
+
venv\Scripts\Activate.ps1
24
39
pip install build
25
40
python -m build
26
41
```
@@ -31,10 +46,10 @@ The built wheel will be placed in the `dist` directory in your DiskANN root. Ins
31
46
Please cite this software in your work as:
32
47
```
33
48
@misc{diskann-github,
34
-
author = {Simhadri, Harsha Vardhan and Krishnaswamy, Ravishankar and Srinivasa, Gopal and Subramanya, Suhas Jayaram and Antonijevic, Andrija and Pryce, Dax and Kaczynski, David and Williams, Shane and Gollapudi, Siddarth and Sivashankar, Varun and Karia, Neel and Singh, Aditi and Jaiswal, Shikhar and Mahapatro, Neelam and Adams, Philip and Tower, Bryan}},
49
+
author = {Simhadri, Harsha Vardhan and Krishnaswamy, Ravishankar and Srinivasa, Gopal and Subramanya, Suhas Jayaram and Antonijevic, Andrija and Pryce, Dax and Kaczynski, David and Williams, Shane and Gollapudi, Siddarth and Sivashankar, Varun and Karia, Neel and Singh, Aditi and Jaiswal, Shikhar and Mahapatro, Neelam and Adams, Philip and Tower, Bryan and Patel, Yash}},
35
50
title = {{DiskANN: Graph-structured Indices for Scalable, Fast, Fresh and Filtered Approximate Nearest Neighbor Search}},
0 commit comments