Add from_config for abstract distance, search, and store (#366)

* [nightly] Increase version to 0.18.0.dev12

* Change import to use TF keras legacy utils to access serialize and deserialize.

* Add try/except to handle updated import path in tf 2.13

* Add from_config to abstract classes to support deserialization.

* Fix typing on from_config for search and store

---------

Co-authored-by: Github Actions Bot <[email protected]>

Author: owenvallis

tensorflow_similarity/distances/distance.py

@@ -54,3 +54,20 @@ def get_config(self) -> dict[str, Any]:
         config = {"name": self.name}
 
         return config
+
+    @classmethod
+    def from_config(cls, config: dict[str, Any]) -> Distance:
+        """Build a distance from a config.
+
+        Args:
+            config: A Python dict containing the configuration of the distance.
+
+        Returns:
+            A distance instance.
+        """
+        try:
+            return cls(**config)
+        except Exception as e:
+            raise TypeError(
+                f"Error when deserializing '{cls.__name__}' using" f"config={config}.\n\nException encountered: {e}"
+            )

tensorflow_similarity/search/search.py

@@ -135,3 +135,20 @@ def get_config(self) -> dict[str, Any]:
     def is_built(self):
         "Returns whether or not the index is built and ready for querying." ""
         return self.built
+
+    @classmethod
+    def from_config(cls, config: dict[str, Any]) -> Search:
+        """Build a search from a config.
+
+        Args:
+            config: A Python dict containing the configuration of the search.
+
+        Returns:
+            A distance instance.
+        """
+        try:
+            return cls(**config)
+        except Exception as e:
+            raise TypeError(
+                f"Error when deserializing '{cls.__name__}' using" f"config={config}.\n\nException encountered: {e}"
+            )

tensorflow_similarity/stores/store.py

@@ -151,3 +151,20 @@ def get_config(self) -> dict[str, Any]:
         }
 
         return config
+
+    @classmethod
+    def from_config(cls, config: dict[str, Any]) -> Store:
+        """Build a store from a config.
+
+        Args:
+            config: A Python dict containing the configuration of the store.
+
+        Returns:
+            A distance instance.
+        """
+        try:
+            return cls(**config)
+        except Exception as e:
+            raise TypeError(
+                f"Error when deserializing '{cls.__name__}' using" f"config={config}.\n\nException encountered: {e}"
+            )