Neighbors -> Neighbor in PNNS (#13)

apple · Sep 27, 2024 · e2fcb50 · e2fcb50
1 parent 4b54a2a
commit e2fcb50
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/apple/swift_homomorphic_encryption/api/pnns/v1/pnns.proto b/apple/swift_homomorphic_encryption/api/pnns/v1/pnns.proto
@@ -31,7 +31,7 @@ message PNNSConfig {
   apple.swift_homomorphic_encryption.pnns.v1.MatrixPacking query_packing = 3;
   // Number of entries in each vector.
   uint32 vector_dimension = 4;
-  // Metric for similarity computation.
+  // Metric for computing distances.
   apple.swift_homomorphic_encryption.pnns.v1.DistanceMetric distance_metric = 5;
   // hash of EvaluationKeyConfig.
   bytes evaluation_key_config_hash = 6;

diff --git a/apple/swift_homomorphic_encryption/pnns/v1/pnns_client_config.proto b/apple/swift_homomorphic_encryption/pnns/v1/pnns_client_config.proto
@@ -29,7 +29,7 @@ message ClientConfig {
   MatrixPacking query_packing = 3;
   // Number of entries in each vector.
   uint32 vector_dimension = 4;
-  // Galois elements required for nearest neighbors computation.
+  // Galois elements required for nearest neighbor search.
   repeated uint32 galois_elements = 5;
   // Metric for distances between vectors.
   DistanceMetric distance_metric = 6;

diff --git a/apple/swift_homomorphic_encryption/pnns/v1/pnns_database.proto b/apple/swift_homomorphic_encryption/pnns/v1/pnns_database.proto
@@ -15,17 +15,17 @@
 syntax = "proto3";
 package apple.swift_homomorphic_encryption.pnns.v1;
 
-// Row in a private nearest neighbors search database.
+// Row in a private nearest neighbor search database.
 message DatabaseRow {
   // Unique identifier for the database entry.
   uint64 entry_id = 1;
   // Metadata associated with the entry.
   bytes entry_metadata = 2;
-  // Vector for use in nearest neighbors computation.
+  // Vector for use in nearest neighbor search.
   repeated float vector = 3;
 }
 
-// A private nearest neighbors search database.
+// A private nearest neighbor search database.
 message Database {
   // Rows in the database.
   repeated DatabaseRow rows = 1;

diff --git a/apple/swift_homomorphic_encryption/pnns/v1/pnns_processed_database.proto b/apple/swift_homomorphic_encryption/pnns/v1/pnns_processed_database.proto
@@ -18,9 +18,9 @@ package apple.swift_homomorphic_encryption.pnns.v1;
 import "apple/swift_homomorphic_encryption/pnns/v1/pnns.proto";
 import "apple/swift_homomorphic_encryption/pnns/v1/pnns_server_config.proto";
 
-// Serialized pre-processed nearest neighbors database.
+// Serialized pre-processed nearest neighbor database.
 message SerializedProcessedDatabase {
-  // Pre-computed values for the nearest neighbors computation, one per plaintext CRT modulus.
+  // Pre-computed values for the nearest neighbor search, one per plaintext CRT modulus.
   repeated SerializedPlaintextMatrix plaintext_matrices = 1;
   // Unique identifier for each entry in the database.
   repeated uint64 entry_ids = 2;