openvino icon indicating copy to clipboard operation
openvino copied to clipboard

[Good First Issue][JAX FE]: Support jax.lax.gather operation for JAX

Open rkazants opened this issue 1 year ago • 2 comments

Context

OpenVINO component responsible for support of JAX/Flax models is called as JAX Frontend (JAX FE). JAX FE converts a JAX/Flax model represented by ClosedJAXpr graph object with operations from jax.lax opset to OpenVINO IR containing operations from OpenVINO opset.

In order to infer JAX/Flax models containing jax.lax.gather operation by OpenVINO, JAX FE needs to be extended with this operation support.

What needs to be done?

For jax.lax.gather operation support, you need to implement the corresponding loader into JAX FE op directory and to register it into the dictionary of Loaders. One loader is responsible for conversion (or decomposition) of one type of JAX operation.

Here is an example of loader implementation for jax.lax.reshape operation:

OutputVector translate_reshape(const NodeContext& context) {
    num_inputs_check(context, 1, 1);
    Output<Node> input = context.get_input(0);
    auto new_sizes = context.const_named_param<std::vector<int64_t>>("new_sizes");
    if (context.has_param("dimensions")) {
        auto dimensions = context.const_named_param<std::vector<int64_t>>("dimensions");
        // transpose the input first.
        auto permutation_node = std::make_shared<v0::Constant>(element::i64, Shape{dimensions.size()}, dimensions);
        input = std::make_shared<v1::Transpose>(input, permutation_node);
    }

    auto new_shape_node = std::make_shared<v0::Constant>(element::i64, Shape{new_sizes.size()}, new_sizes);
    Output<Node> res = std::make_shared<v1::Reshape>(input, new_shape_node, false);
    return {res};
};

In this example, translate_reshape expresses jax.lax.reshape using OpenVINO opset. Since jax.lax.reshape performs transposition and tensor reshaping according to JAX documentation, the resulted decomposition contains OpenVINO Transpose and Reshape operations. For Transpose and Reshape nodes, this conversion parses constant parameters dimensions to permute input tensor and new_size that is the target shape of the result.

Once you are done with implementation of the translator, you need to implement the corresponding layer tests test_gather.py and put it into layer_tests/jax_tests directory. Example how to run some layer test:

export TEST_DEVICE=CPU
export JAX_TRACE_MODE=JAXPR
export 
cd openvino/tests/layer_tests/jax_tests
pytest test_reshape.py

Example Pull Requests

  • https://github.com/openvinotoolkit/openvino/pull/26288
  • https://github.com/openvinotoolkit/openvino/pull/26254

Resources

Contact points

  • @openvinotoolkit/openvino-jax-frontend-maintainers
  • @rkazants in GitHub and Discord

Ticket

No response

rkazants avatar Sep 12 '24 20:09 rkazants

hi @rkazants I would like to take up this issue

NilayPatel10721 avatar Sep 18 '24 03:09 NilayPatel10721

The task is yours @NilayPatel10721, have fun :)

mlukasze avatar Sep 18 '24 04:09 mlukasze

.take

amansharma612 avatar Nov 16 '24 19:11 amansharma612

Thank you for looking into this issue! Please let us know if you have any questions or require any help.

github-actions[bot] avatar Nov 16 '24 19:11 github-actions[bot]

I am probably taking this. Let me do an preliminary assessment.

sohale avatar Jan 14 '25 20:01 sohale

.take

sohale avatar Jan 14 '25 20:01 sohale

Thank you for looking into this issue! Please let us know if you have any questions or require any help.

github-actions[bot] avatar Jan 14 '25 20:01 github-actions[bot]

Update: I am on this.

sohale avatar Feb 05 '25 16:02 sohale

Hello @sohale, are you still working on it? Do you require any help?

p-wysocki avatar Mar 05 '25 12:03 p-wysocki

.take

Jyc323 avatar Mar 12 '25 16:03 Jyc323

Thank you for looking into this issue! Please let us know if you have any questions or require any help.

github-actions[bot] avatar Mar 12 '25 16:03 github-actions[bot]