Documentation of enums defined in rust (#9491)

GitOrigin-RevId: 0c647224921cddae42404a6b12c6b556eb4c0970

Author: szymondudycz

python/pathway/persistence/__init__.py

@@ -119,9 +119,10 @@ class Config:
     parameter to pw.run in case persistence is enabled.
 
     Args:
-        backend: persistence backend configuration;
+        backend: persistence backend configuration.
         snapshot_interval_ms: the desired duration between snapshot updates in \
-milliseconds;
+milliseconds.
+        persistence_mode: sets the persistence mode. See :py:class:`pathway.PersistenceMode` for more details.
     """
 
     backend: Backend
@@ -154,31 +155,17 @@ def simple_config(
                 the snapshot may fall behind, and the less computational resources are
                 required.
             persistence_mode: Can be set to one of the following values.
-                ``api.PersistenceMode.PERSISTING``: the default value and means that all data
+                ``pw.PersistenceMode.PERSISTING``: the default value and means that all data
                 will be persisted. When this parameter is specified, or when it is omitted,
                 and the configuration is passed to ``pw.run``, no additional actions are
                 required to persist the state of your program. Alternatively, you can use
-                ``api.PersistenceMode.UDF_CACHING`` meaning that only user-defined function (UDF)
+                ``pw.PersistenceMode.UDF_CACHING`` meaning that only user-defined function (UDF)
                 calls will be cached. The cache stores the mapping from function input parameters to
                 their results, so if a function is called again with the same inputs,
                 the cached result is returned.
 
         Returns:
             Persistence config.
-
-        Note:
-
-        ``api.PersistenceMode.UDF_CACHING`` currently works either when the File System
-        is used as the backend for persistent storage, or, if another backend is used, a
-        temporary directory will be created for writing the cache. In the latter case,
-        persistence guarantees are not provided.
-
-        By default, ``api.PersistenceMode.UDF_CACHING`` does not persist data from input
-        sources. This means that if the program restarts, it will re-read all input streams
-        from the beginning. However, this behavior can be overridden by assigning names
-        to specific input sources. If an input connector has a name parameter, the input
-        stream for this source will also be persisted. Upon restart, the program will
-        resume reading from the point where it previously stopped.
         """
 
         warnings.warn(

src/python_api.rs

@@ -4480,6 +4480,24 @@ pub struct DataStorage {
     iceberg_catalog: Option<IcebergCatalogSettings>,
 }
 
+/// Specifies the type of persistence used by Pathway.
+///
+///   Attributes:
+///     PERSISTING: Persists all data and state necessary to fully restore the computation.
+///     UDF_CACHING: Only the results of UDFs, for which `cache_strategy` is set, are persisted, however, the data
+///       needs to be read again by the input connectors.
+///       
+///       Note:
+///       ``pw.PersistenceMode.UDF_CACHING`` currently works either when the File System
+///       is used as the backend for persistent storage, or, if another backend is used, a
+///       temporary directory will be created for writing the cache. In the latter case,
+///       persistence guarantees are not provided.
+///       By default, ``pw.PersistenceMode.UDF_CACHING`` does not persist data from input
+///       sources. This means that if the program restarts, it will re-read all input streams
+///       from the beginning. However, this behavior can be overridden by assigning names
+///       to specific input sources. If an input connector has a name parameter, the input
+///       stream for this source will also be persisted. Upon restart, the program will
+///       resume reading from the point where it previously stopped.
 #[pyclass(module = "pathway.engine", frozen, name = "PersistenceMode")]
 pub struct PyPersistenceMode(PersistenceMode);
 

src/python_api/external_index_wrappers.rs

@@ -161,6 +161,21 @@ impl PyExternalIndexQuery {
     }
 }
 
+/// Used for choosing the metric used in the USearchKnn index.
+/// As these correspond to values of `MetricKind` from the usearch crate,
+/// you can find more information about them in the
+/// `usearch documentation <https://docs.rs/usearch/latest/usearch/ffi/struct.MetricKind.html>`_.
+///
+/// Attributes:
+///   IP: Inner Product distance.
+///   L2SQ: Squared Euclidean distance.
+///   COS: Cosine distance.
+///   PEARSON: Pearson distance.
+///   HAVERSINE: Haversine distance.
+///   DIVERGENCE: Jensen Shannon Divergence distance.
+///   HAMMING: Hamming distance.
+///   TANIMOTO: Tanimoto distance.
+///   SORENSEN: Sorensen distance.
 #[pyclass(module = "pathway.engine", frozen, name = "USearchMetricKind")]
 pub struct PyUSearchMetricKind(USearchMetricKind);
 
@@ -201,6 +216,11 @@ impl<'py> IntoPyObject<'py> for USearchMetricKind {
     }
 }
 
+/// Used for choosing the metric used in the BruteForceKnn index.
+///
+/// Attributes:
+///   L2SQ: Squared Euclidean distance.
+///   COS: Cosine distance.
 #[pyclass(module = "pathway.engine", frozen, name = "BruteForceKnnMetricKind")]
 pub struct PyBruteForceKnnMetricKind(BruteForceKnnMetricKind);