Improve docstring and README consistency in gnm.shape#24
Closed
manumishra12 wants to merge 1 commit into
Closed
Conversation
- gnm_numpy/gnm_jax/gnm_tensorflow: give compute_vertex_normals the same Args/Returns docstring the PyTorch backend already has. - gnm_tensorflow: document the GNM attributes that the other backends list but the TF class docstring omitted (quad_uvs, triangle_uvs, mesh_component_names, mirror_indices, variant, vertex_groups, vertex_group_names, joint_connections, joint_children_indices, skinning_segmentation, edge_list, vertex_uvs) and add the missing P shape dimension. - README: the per-joint rotations are axis-angle vectors of shape [batch_size, num_joints, 3], not a "4x3 Rotation matrix".
manumishra12
force-pushed
the
pr2/docstring-consistency
branch
from
July 18, 2026 09:31
007e9ff to
9274a72
Compare
Contributor
Author
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
1 participant
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.
Improves docstring and README consistency across the
gnm/shapebackends. No behavior change.bare one-line docstring while PyTorch documented
Args:/Returns:. Give thethree the same documentation.
GNMclass docstring omitted several attributesthat the base class and the other backends document. Add them
(
quad_uvs,triangle_uvs,mesh_component_names,mirror_indices,variant,vertex_groups,vertex_group_names,joint_connections,joint_children_indices,skinning_segmentation,edge_list,vertex_uvs) and the missingPshape dimension.vectors of shape
[batch_size, num_joints, 3](see the demo, which commentsthe array
# Axis-angle), not a4x3 Rotation matrix.