Rename ip to inner_product and update properties and README

Author: yabsp

.gitignore

@@ -257,6 +257,7 @@ nbdist/
 !/libs/PolySqlParser-1.0.jar
 
 /results.csv
+/results-pg.csv
 /recall-groundtruth.csv
 
 # humble video libraries

src/main/java/org/polypheny/simpleclient/scenario/vectorbench/queryBuilder/postgres/ddl/PgCreateRealFeatureIndex.java

@@ -54,7 +54,7 @@ private static String toOpClass( String metric ) {
             case "cosine" -> "vector_cosine_ops";
             case "l2" -> "vector_l2_ops";
             case "l1" -> "vector_l1_ops";
-            case "ip" -> "vector_ip_ops";
+            case "inner_product" -> "vector_ip_ops";
             default -> throw new IllegalArgumentException( "Provided metric is invalid: " + metric );
         };
     }

src/main/java/org/polypheny/simpleclient/scenario/vectorbench/queryBuilder/postgres/dql/PgSimpleKnnRealFeature.java

@@ -55,7 +55,7 @@ private static String toOperator( String metric ) {
             case "cosine" -> "<=>";
             case "l2" -> "<->";
             case "l1" -> "<+>";
-            case "ip" -> "<#>";
+            case "inner_product" -> "<#>";
             default -> throw new IllegalArgumentException( "Provided metric is invalid: " + metric );
         };
     }

src/main/java/org/polypheny/simpleclient/scenario/vectorbench/queryBuilder/postgres/dql/PgSimpleKnnRealFeatureFiltered.java

@@ -58,7 +58,7 @@ private static String toOperator( String metric ) {
             case "cosine" -> "<=>";
             case "l2" -> "<->";
             case "l1" -> "<+>";
-            case "ip" -> "<#>";
+            case "inner_product" -> "<#>";
             default -> throw new IllegalArgumentException( "Provided metric is invalid: " + metric );
         };
     }

src/main/resources/org/polypheny/simpleclient/scenario/vectorbench/vector.properties

@@ -11,10 +11,12 @@ postgresImageVariant = Default
 
 # true => DDL: REAL NOT NULL ARRAY(1,3)
 # false => DDL: REAL ARRAY(1,3)
-supportsNotNullArray=true
+# Note: Ignored by direct postgres path
+supportsNotNullArray = false
 
 # False -> Does not create index
-useIndex = false
+# Note: When run in cli, vector index will not create indexes if set to false
+useIndex = true
 
 # Query-time index parameters (direct-postgres path only, ignored on the Polypheny path).
 # ---------------------------------------------------------------------------------------
@@ -25,8 +27,9 @@ queryEfSearch = 40
 queryProbes = 1
 # ---------------------------------------------------------------------------------------
 
-# Vector index settings, hnsw or ivfflat
-indexMethod = hnsw
+# Vector index settings,
+# Method: hnsw or ivfflat
+indexMethod = ivfflat
 # Only used for HNSW index
 indexM = 16
 indexEfConstruction = 64
@@ -45,7 +48,7 @@ progressReportBase = 100
 numberOfWarmUpIterations = 4
 
 # Seeds
-# Note that when running using CLI and doing an index recall this should be turned off
+# Note: When running using CLI and doing an index recall this should be turned off
 useRandomSeeds = false
 randomSeedInsert = 46891971806236
 randomSeedQuery = 196033374268
@@ -65,21 +68,22 @@ numberOfMetadataKnnIntFeatureQueries = 0
 numberOfSimpleMetadataQueries = 10
 
 # Real (float vector mapping)
-numberOfSimpleKnnRealFeatureQueries = 0
-numberOfSimpleKnnIdRealFeatureQueries = 0
-numberOfMetadataKnnRealFeatureQueries = 0
+numberOfSimpleKnnRealFeatureQueries = 10
+numberOfSimpleKnnIdRealFeatureQueries = 10
+numberOfMetadataKnnRealFeatureQueries = 10
 numberOfSimpleKnnRealCrossJoinQueries = 10
 numberOfMetadataKnnRealCrossJoinQueries = 10
-numberOfSimpleKnnRealFeatureFilteredQueries = 0
+numberOfSimpleKnnRealFeatureFilteredQueries = 10
 
 # Boolean (bit vector mapping)
-numberOfSimpleKnnBooleanFeatureFilteredQueries = 0
-numberOfSimpleKnnBooleanFeatureQueries = 0
+numberOfSimpleKnnBooleanFeatureFilteredQueries = 10
+numberOfSimpleKnnBooleanFeatureQueries = 10
 
 
 limitKnnQueries = 10
-# L1, L2, COSINE, IP
+# L1, L2, COSINE, INNER_PRODUCT
 distanceNorm = L2
 # HAMMING, JACCARD
-booleanDistanceNorm = HAMMING
+booleanDistanceNorm = JACCARD
+# Note: When ivfflat is selected as indexMethod, JACCARD and L1 indexes are not created and the step is skipped.