Skip to content

Improve docstring and README consistency in gnm.shape#35

Open
manumishra12 wants to merge 1 commit into
google:mainfrom
manumishra12:pr2/docstring-consistency
Open

Improve docstring and README consistency in gnm.shape#35
manumishra12 wants to merge 1 commit into
google:mainfrom
manumishra12:pr2/docstring-consistency

Conversation

@manumishra12

Copy link
Copy Markdown
Contributor

Replaces #24, which GitHub auto-closed after a force-push that removed
accidentally committed __pycache__/*.pyc files from the branch. Same
changes as #24, now without those bytecode files.

Improves docstring and README consistency across the gnm/shape backends. No behavior change.

  • compute_vertex_normals: the NumPy, JAX, and TensorFlow backends had a
    bare one-line docstring while PyTorch documented Args:/Returns:. Give the
    three the same documentation.
  • gnm_tensorflow: the TF GNM class docstring omitted several attributes
    that 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 missing P shape dimension.
  • README: the per-joint rotations passed to the model are axis-angle
    vectors of shape [batch_size, num_joints, 3] (see the demo, which comments
    the array # Axis-angle), not a 4x3 Rotation matrix.

- 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".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant