imt-ring 1.6.25__tar.gz → 1.6.26__tar.gz

{imt_ring-1.6.25 → imt_ring-1.6.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imt-ring
-Version: 1.6.25
+Version: 1.6.26
 Summary: RING: Recurrent Inertial Graph-based Estimator
 Author-email: Simon Bachhuber <simon.bachhuber@fau.de>
 Project-URL: Homepage, https://github.com/SimiPixel/ring

{imt_ring-1.6.25 → imt_ring-1.6.26}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "imt-ring"
-version = "1.6.25"
+version = "1.6.26"
 authors = [
   { name="Simon Bachhuber", email="simon.bachhuber@fau.de" },
 ]

{imt_ring-1.6.25 → imt_ring-1.6.26}/src/imt_ring.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imt-ring
-Version: 1.6.25
+Version: 1.6.26
 Summary: RING: Recurrent Inertial Graph-based Estimator
 Author-email: Simon Bachhuber <simon.bachhuber@fau.de>
 Project-URL: Homepage, https://github.com/SimiPixel/ring

{imt_ring-1.6.25 → imt_ring-1.6.26}/src/ring/ml/ml_utils.py

@@ -251,6 +251,48 @@ def to_onnx(
     out_args_names: Optional[list[str]] = None,
     validate: bool = False,
 ):
+    """
+    Converts a JAX function to ONNX format, with optional input/output renaming and validation.
+
+    Args:
+        fn (callable): The JAX function to be converted.
+        output_path (str): Path where the ONNX model will be saved.
+        *args (tuple[np.ndarray]): Input arguments for the JAX function.
+        in_args_names (Optional[list[str]]): Names for the ONNX model's input tensors. Defaults to None.
+        out_args_names (Optional[list[str]]): Names for the ONNX model's output tensors. Defaults to None.
+        validate (bool): Whether to validate the ONNX model against the JAX function's outputs. Defaults to False.
+
+    Raises:
+        AssertionError: If the number of provided names does not match the number of inputs/outputs.
+        AssertionError: If the ONNX model's outputs do not match the JAX function's outputs within tolerance.
+        ValueError: If any error occurs during ONNX conversion, saving, or validation.
+
+    Notes:
+        - The function uses `jax2tf` to convert the JAX function to TensorFlow format,
+          and `tf2onnx` for ONNX conversion.
+        - Input and output tensor names in the ONNX model can be renamed using `sor4onnx.rename`.
+        - Validation compares outputs of the JAX function and the ONNX model using ONNX Runtime.
+
+    Example:
+        ```
+        import jax.numpy as jnp
+
+        def my_fn(x, y):
+            return x + y, x * y
+
+        x = jnp.array([1, 2, 3])
+        y = jnp.array([4, 5, 6])
+
+        to_onnx(
+            my_fn,
+            "model.onnx",
+            x, y,
+            in_args_names=["input1", "input2"],
+            out_args_names=["sum", "product"],
+            validate=True,
+        )
+        ```
+    """  # noqa: E501
     import jax.experimental.jax2tf as jax2tf
     import tensorflow as tf
     import tf2onnx

{imt_ring-1.6.25 → imt_ring-1.6.26}/src/ring/ml/train.py

@@ -45,7 +45,7 @@ def _build_step_fn(
 
     @partial(jax.value_and_grad, has_aux=True)
     def loss_fn(params, state, X, y):
-        yhat, state = filter.apply(params=params, state=state, X=X)
+        yhat, state = filter.apply(params=params, state=state, X=X, y=y)
         # this vmap maps along batch-axis, not time-axis
         # time-axis is handled by `metric_fn`
         pipe = lambda q, qhat: jnp.mean(jax.vmap(metric_fn)(q, qhat))
@@ -261,7 +261,7 @@ def _build_eval_fn(
     """Build function that evaluates the filter performance."""
 
     def eval_fn(params, state, X, y):
-        yhat, _ = filter.apply(params=params, state=state, X=X)
+        yhat, _ = filter.apply(params=params, state=state, X=X, y=y)
 
         y = _arr_to_dict(y, link_names)
         yhat = _arr_to_dict(yhat, link_names)