narangvivek10 commented on code in PR #3615:
URL: https://github.com/apache/solr/pull/3615#discussion_r2382606375


##########
solr/modules/cuvs/README.md:
##########
@@ -0,0 +1,268 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+Welcome to Apache Solr's cuVS module!
+========
+
+> [!CAUTION]
+> This feature is currently experimental.
+
+# Introduction
+
+Building HNSW graphs, especially with high dimensions and cardinality, is 
usually slow. If you have NVIDIA GPUs then building HNSW based indexes can be 
sped up manifold. This is powered by the 
[cuVS-Lucene](https://github.com/rapidsai/cuvs-lucene) library, a pluggable 
vectors format for Apache Lucene. It uses the state of the art [CAGRA 
algorithm](https://arxiv.org/abs/2308.15136) for quickly building a fixed 
degree connected graph, which is then serialized into a HNSW graph. [CUDA 
13.0+](https://developer.nvidia.com/cuda-downloads) and [JDK 
22](https://jdk.java.net/archive/) are required to use this feature.
+
+
+To try this out, first copy the module jar files (found in the regular Solr 
tarball, not the slim one) before starting Solr.

Review Comment:
   Updated readme - removed the description.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to