Skip to content

fix(jax): improve JAX modules' names #5214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
njzjz merged 4 commits into from
Feb 11, 2026
Merged

fix(jax): improve JAX modules' names #5214

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
51985af
fix(jax): improve JAX modules' names
njzjz Feb 9, 2026
551721a
address Copilot's suggestion
njzjz Feb 10, 2026
3688dd2
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 10, 2026
f1b2b3e
Add TypeVar import to common.py
njzjz Feb 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions deepmd/jax/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from functools import (
wraps,
)
from typing import (
Any,
TypeVar,
overload,
)

import numpy as np

from deepmd.dpmodel.common import (
NativeOP,
)
from deepmd.jax.env import (
jnp,
nnx,
Expand Down Expand Up @@ -41,19 +42,22 @@ def to_jax_array(array: np.ndarray | None) -> jnp.ndarray | None:
return jnp.array(array)


T = TypeVar("T")
Comment thread
coderabbitai[bot] marked this conversation as resolved.


def flax_module(
module: NativeOP,
) -> nnx.Module:
module: type[T],
) -> type[T]: # runtime: actually returns type[T & nnx.Module]
"""Convert a NativeOP to a Flax module.

Parameters
----------
module : NativeOP
module : type[NativeOP]
The NativeOP to convert.

Returns
-------
flax.nnx.Module
type[flax.nnx.Module]
The Flax module.
Comment thread
njzjz marked this conversation as resolved.

Examples
Expand All @@ -72,6 +76,7 @@ class MixedMetaClass(*metas):
def __call__(self, *args: Any, **kwargs: Any) -> Any:
return type(nnx.Module).__call__(self, *args, **kwargs)

@wraps(module, updated=())
class FlaxModule(module, nnx.Module, metaclass=MixedMetaClass):
def __init_subclass__(cls, **kwargs: Any) -> None:
Comment thread
njzjz marked this conversation as resolved.
return super().__init_subclass__(**kwargs)
Expand Down