chore: add type annotations to grpo_utils based on docstrings#4076
Open
harshaa765 wants to merge 1 commit into
Open
chore: add type annotations to grpo_utils based on docstrings#4076harshaa765 wants to merge 1 commit into
harshaa765 wants to merge 1 commit into
Conversation
Annotates all previously unannotated function signatures in
experimental/rl/grpo_utils.py using jax.Array, nnx.Module,
jax.sharding.{Mesh,Sharding,NamedSharding}, np.ndarray, and standard
Python typing (Any, Callable, tuple, list, dict) — no new dependencies.
- Core log-prob helpers: inputs typed as jax.Array, returns tuple[jax.Array, dict[str, Any]]
- Resharding helpers: shardings typed with jax.sharding.*, returns None or Callable[..., Any]
- Data pipeline helpers: dicts typed as dict[str, Any], sequences as list[np.ndarray]
- Nested helpers (_get_sharding_dims, reshard_fn) also annotated
- Existing jaxtyping.PyTree annotations on reshard_pytree left unchanged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds Python type annotations to all previously unannotated function signatures in
src/maxtext/experimental/rl/grpo_utils.py.compute_log_probs,compute_log_probs_nnx): inputs typed asjax.Array, returns astuple[jax.Array, dict[str, Any]]compute_log_probs_nnx):modeltyped asnnx.Modulepathways_reshard,pathways_reshard_nnx,_maybe_find_intermediate_sharding,reshard_pytree-path): shardings typed withjax.sharding.{Mesh,Sharding,NamedSharding}, functions returningNoneorCallable[..., Any]made explicitpad_or_trim,filter_and_split,generate_offline_completions): dicts typed asdict[str, Any], sequences aslist[np.ndarray], scalars asint | float_get_sharding_dims,reshard_fn): also annotated inlineNo new dependencies introduced — annotations use only
jax.Array,nnx.Module,jax.sharding.*,np.ndarray, and standardtypingprimitives (Any,Callable). The existingjaxtyping.PyTreeannotations onreshard_pytreeare left unchanged.Test plan
ast.parsesyntax check passes locally.tests/unit/grpo_nnx_test.pycontinue to cover the annotated functions.