jax-ml/jax

lax.conv_transpose has different convention than TF, document it and make switching easy?

Open

#14,337 opened on Feb 7, 2023

View on GitHubContributor guide
 (11 comments) (0 reactions) (0 assignees)Python (3,738 forks)github user discovery
documentationenhancementgood first issue

Repository metrics

Stars
 (36,174 stars)
PR merge metrics
 (Avg merge 2d 19h) (439 merged PRs in 30d)

Description

See screenshot:

Though the example uses Haiku, Haiku is just calling through to lax.conv_transpose.

The difference is in reversing the spatial axes of the kernel.

We can do at least two things to make this less surprising and more easily fixable:

  1. document the difference, and
  2. add an argument to lax.conv_transpose to instead use the TF convention.

Contributor guide

Research direction
Inspect the 'lax.conv transpose' implementation in JAX, compare the kernel axis convention with TensorFlow's, then add a parameter to switch conventions and update documentation.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonJAX
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65