🚀 Contributing to Keras 🚀

Question

🚀 Contributing to Keras 🚀

fchollet opened this issue a year ago · 51 comments

fchollet commented a year ago

Keras 3 is a high-velocity open-source project. We welcome contributions! Here's what you can do:

Take up one of these items:

Here are some features that we'd love to see implemented by the Keras community:

Add cuDNN support for PyTorch RNNs by implementing keras/backend/torch/rnn.py:cudnn_lstm and cudnn_gru.
Add support for ONNX in model.export() and ExportArchive. On the TF and JAX side, we can transit via SavedModel. On the torch side, we can do a native export.
Implement tool for saved Keras model file inspection, diff, and patching. It could:
- Take a fname.keras file and display the manifest of its contents (including weights file structure)
- Take a fname.weights.h5 and display the manifest of its content.
- Diff two weights files, highlighting what's in one and not in the other.
- Patch a file, by replacing a given weight with a different value provided by the user.
Add all models from keras.applications to keras_cv.models, e.g. Xception, ConvNeXt, etc.
Update KerasCV models to make sure they also work in channels_first mode.
Add a new Flash Attention op, as keras.ops.nn.flash_attention. See #19418

Check out TODOs

There are various TODOs in the codebase. You can do a quick search (e.g. grep "TODO" keras/ -r) and see if anything looks interesting to you. Make sure to ask in this thread before starting work on any item!

Bring new pretrained model implementations to KerasCV and KerasNLP

The Keras ecosystem packages KerasCV and KerasNLP are looking for contributors!

If you'd like to port a pretrained model implementation to the Keras ecosystem, these packages are great projects to join.

Convert an example from keras.io to Keras 3

keras.io/examples offers many great tutorials, but many of them are still based on Keras 2. We'd like to bring over in the shiny new world of multi-framework ML.

There are two stages of conversion:

Converting a Keras 2 example so that it can run on Keras 3 with the TF backend.
Converting a Keras 2 example so that it can run on Keras 3 with any backend.

If you see an example marked as "v2" on keras.io/examples, you can open a PR on keras-team/keras-io to convert it to Keras 3. Keep in mind:

Start by only including the Python file in the PR, not the md and ipynb files, because you may have to regenerate those after review comments come in.
To convert the code, you can refer to the Keras 3 migration guide.

Add new examples to keras.io

Have a great ML project you'd like to use to teach others about ML? You can add a new tutorial on keras.io/examples! Just follow the instructions at keras-team/keras-io.

Increase test coverage

Keras doesn't have 100% code coverage in unit tests just yet. You can try to run a code coverage tool like codecov and see if there are any unit tests you could add to improve Keras.

Answer 1 · 2023-07-16T03:44:56.000Z

Taking up the Moving Dataset utils task as a priority! Should I make a draft PR?

Answer 2 · 2023-07-16T06:30:33.000Z

Taking up the Moving Dataset utils task as a priority! Should I make a draft PR?

No need for a draft -- you can just send the PR when you have something you want a review on. Thank you!

Answer 3 · 2023-07-16T12:06:46.000Z

@fchollet regarding dataset utils, since all three frameworks tensorflow , torch and jax have their own data-loading modules or have specific classes to provide this utilities, but currently it is relying on tf.keras can only accept either tf.Dataset or regular python structures as of now, so dropping it means that we either support similar logic for individual framework or we accept generic structures + framework specific data-holder and convert it to a unified keras data-holder and then perform similar operations.

since in first option we import framework specific modules and built on top but these will stay in keras.backend but in option two we we don't need to touch keras.backend' we only made changes to keras.utils`. Can you please let me know your thoughts on this. 😊

@suvadityamuk can please also share your thoughts in which direction you are choosing. 😊

Answer 4 · 2023-07-16T12:18:07.000Z

@asingh9530

I'm currently looking into trying to move the tf.keras-specific data utils from the original keras-team/keras space to this space, with all implementations intact. The only thing I'm adding is support to handle torch.utils.data.Dataset along with it, since that's a major focus.

Answer 5 · 2023-07-16T13:54:18.000Z

@suvadityamuk Thanks for responding, since this will be a big change let's track it in a new issue with specific changes needed to be done since even in keras the utils are for tf.Dataset let's say Iterators, batched etc. How about I'll add you there and work on this.

Answer 6 · 2023-07-24T21:13:01.000Z

Hello,
I am rather new w.r.t contributions, so I may ask a rather silly question : are publicly exported functions those decorated with @keras_core_export ?

Answer 7 · 2023-07-25T22:26:16.000Z

so I may ask a rather silly question : are publicly exported functions those decorated with @keras_core_export

Yes, that's right. The public API is programmatically generated using those decorators.

Answer 8 · 2023-08-24T20:04:22.000Z

Can someone help me with keras_core/layers/layer.py:439: # TODO: handle layout.What does it mean to handle the layout?

Answer 9 · 2023-08-29T17:23:58.000Z

@fchollet bump

Answer 10 · 2023-09-16T21:46:24.000Z

Can someone help me with keras_core/layers/layer.py:439: # TODO: handle layout.What does it mean to handle the layout?

This was referring to the implementation of a future distribution API -- but this has been handled since. Nothing to do here.

Answer 11 · 2023-09-16T23:40:40.000Z

Hi,

I am willing to take a shot at the solve operation implementation, still setting up a development environment. One clarification question. What is the error value for a matrix input that is singular (i.e., no inverse matrix exists), not full rank, or not square? To be sure, I look forward to contributing as a hobby and will circle back when I have something satisfactory for review.

Thanks,
bf

Answer 12 · 2023-09-17T12:37:33.000Z

Hello @fchollet,

I wanted to reach out and update you on the progress I've made with the ERF function. I've made significant changes to the code and have already uploaded them to my forked repository. I'm confident that these updates will improve the function's performance, but please take a look and let me know if there's anything else you'd like me to do.

1.) Changes to keras-core/ops/math.py
https://github.com/sqali/keras-core/blob/6485433201e8a935f462aca191bc37dd7cf00c30/keras_core/ops/math.py#L934-L966

2.) Changes to keras-core/ops/math_test.py
https://github.com/sqali/keras-core/blob/6485433201e8a935f462aca191bc37dd7cf00c30/keras_core/ops/math_test.py#L840-L868

3.) Changes to keras-core/backend/tensorflow/math.py
https://github.com/sqali/keras-core/blob/6485433201e8a935f462aca191bc37dd7cf00c30/keras_core/backend/tensorflow/math.py#L244-L245

Answer 13 · 2023-09-17T19:36:13.000Z

I am willing to take a shot at the solve operation implementation, still setting up a development environment. One clarification question. What is the error value for a matrix input that is singular (i.e., no inverse matrix exists), not full rank, or not square? To be sure, I look forward to contributing as a hobby and will circle back when I have something satisfactory for review.

solve exists in all 3 backends, so most likely we just want to wrap it. You can check what the error is for a singular matrix for each backend. We should raise a similar error.

Answer 14 · 2023-09-17T19:37:16.000Z

I wanted to reach out and update you on the progress I've made with the ERF function. I've made significant changes to the code and have already uploaded them to my forked repository. I'm confident that these updates will improve the function's performance, but please take a look and let me know if there's anything else you'd like me to do.

It will also need to be implemented for the JAX, torch, and numpy backends. Can you open a PR? We can carry on on the PR.

Answer 15 · 2023-09-18T00:15:20.000Z

Sure, I will do that. Thanks.

Answer 16 · 2023-09-18T15:53:27.000Z

@fchollet , I am interested in contributing to Keras Core. I went through the description above and interested to work on this item "Convert an example from keras.io to Keras Core". Could you please guide me on the steps to follow . Do I need to raise a new pull request.
Thank you

Answer 17 · 2023-09-18T16:04:41.000Z

@fchollet I can take up erf implementation, any specific condition you want in the implementation if not I will follow implementation guideline of rest of operations.

Answer 18 · 2023-09-18T17:11:44.000Z

I can take up the scan op/operation in jax

Answer 19 · 2023-09-18T17:35:35.000Z

Hi @asingh9530 ,

I have already opened a PR for erf and working on it. Thanks.

Answer 20 · 2023-09-18T20:22:30.000Z

Hi people,

I think I took care of most of the necessary changes. Still struggling on how to run a unit test locally with respect to my forked branch. Happy to open a PR if this is helpful. In addition, please advise on how to run a test, import a built whl binary into a Jupyter notebook, and next steps for agnostic solve.

Thanks,
bf

Answer 21 · 2023-09-19T11:20:19.000Z

@fchollet I'm working on the keras_core/saving/saving_lib.py. TODO: if h5 filepath is remote, create the file in a temporary directory then upload it. Should I use the requests library to posts the file on the required remote filepath ?

Answer 22 · 2023-09-19T16:55:40.000Z

I'm working on the keras_core/saving/saving_lib.py. TODO: if h5 filepath is remote, create the file in a temporary directory then upload it. Should I use the requests library to posts the file on the required remote filepath ?

Please only use Python stdlib utilities for this. Thanks!

Answer 23 · 2023-09-19T16:56:26.000Z

I am interested in contributing to Keras Core. I went through the description above and interested to work on this item "Convert an example from keras.io to Keras Core". Could you please guide me on the steps to follow . Do I need to raise a new pull request.

Here's the full context and the process to follow: #18468

Answer 24 · 2023-09-19T16:57:49.000Z

I can take up the scan op/operation in jax

Sure, sounds good! It will need to be implemented in all 4 backends though.

I think I took care of most of the necessary changes. Still struggling on how to run a unit test locally with respect to my forked branch. Happy to open a PR if this is helpful. In addition, please advise on how to run a test, import a built whl binary into a Jupyter notebook, and next steps for agnostic solve.

It will need much more extensive unit testing. You can run unit tests locally via pytest.

Answer 25 · 2023-09-19T17:17:36.000Z

I'm working on the keras_core/saving/saving_lib.py. TODO: if h5 filepath is remote, create the file in a temporary directory then upload it. Should I use the requests library to posts the file on the required remote filepath ?

Please only use Python stdlib utilities for this. Thanks!

thanks, last question what can be a good example for remote file path.

Answer 26 · 2023-09-19T20:14:14.000Z

thanks, last question what can be a good example for remote file path.

Something like gcs://...

Answer 27 · 2023-09-20T11:01:52.000Z

I am interested in contributing to Keras Core. I went through the description above and interested to work on this item "Convert an example from keras.io to Keras Core". Could you please guide me on the steps to follow . Do I need to raise a new pull request.

Here's the full context and the process to follow: #18468

Thank you. I will check the link and start working

Answer 28 · 2023-09-20T15:30:11.000Z

Thanks @fchollet! Debugging more unit tests now, I commented the latest errors I have been seeing in the math._test.py file here. Any ideas to get a more deterministic response from tensorflow are much appreciated.

Answer 29 · 2023-09-21T00:54:12.000Z

I could port some of the listed examples from tf.keras to Keras Core. Out of the outstanding examples, are there any, in particular, you would first like to see ported to Keras Core?

Answer 30 · 2023-09-21T18:24:59.000Z

@fchollet what to do if some framework do not have the feature or it is work in progress( like scan and pytorch pytorch/pytorch#50688)?

Answer 31 · 2023-09-27T15:00:06.000Z

@fchollet ,I was trying to port this example of mixup augmentation https://keras.io/examples/vision/mixup/, while defining Hyperparameters in keras-core, what should we replace this line with AUTO = tf.data.AUTOTUNE? Could you please help clarify the same.

Answer 32 · 2023-10-24T16:41:08.000Z

@fchollet I am interested in solving the todo,
keras/metrics/accuracy_metrics_test.py: # TODO: Check save and restore config

can you give me more detail of how it should be done.

Answer 33 · 2023-11-22T02:19:33.000Z

Hi, @fchollet ,

For my first commit to Keras, I picked a simple one, addressing two small TODO items in reduction_metrics_test.py.

Here's the PR: #18812

I believe what the comment "# TODO: Check save and restore config" meant is that an object (Sum or Mean) must be re-constructed from config, and be tested.

Please let me know if I misunderstood the requirements, or otherwise made any mistakes.

Thank you! I'm very excited about working on this very important library.

Answer 34 · 2023-12-04T13:00:00.000Z

Hi, @fchollet ,

For my first commit to Keras, I picked the TODO in discretization_test.py.

Here's the PR: #18882

Thank you!

Answer 35 · 2023-12-07T16:26:55.000Z

Is anyone working on JAX CTC? If not, I can take it up

Answer 36 · 2024-03-18T20:50:31.000Z

I will take the ops.correlate if nobody is working on it.

Answer 37 · 2024-03-22T09:45:13.000Z

@fchollet I could take dice loss if nobody else is working on it. @vulkomilev did you start with ops.correlate?

Answer 38 · 2024-03-23T08:13:58.000Z

@fchollet can you or someone add me as a contributor? I need to make a push to the remote branch for the dice loss.

Answer 39 · 2024-03-24T11:13:34.000Z

@fchollet I have the first version of the DiceLoss in the tf backend. I need to be made a contributor to make a push to the remote branch so that the code review can take place.

Answer 40 · 2024-03-27T11:43:59.000Z

@fchollet any updates for the DiceLoss? I have the TF implementation ready.

Answer 41 · 2024-03-28T21:24:57.000Z

@fchollet I could take dice loss if nobody else is working on it. @vulkomilev did you start with ops.correlate?

yes I did

Answer 42 · 2024-03-29T10:05:37.000Z

@vulkomilev Thanks for the answer. Are you a contributor? How do you do the push to the branch? I have this dice loss done, but cannot push since I am not a contributor.

Answer 43 · 2024-03-31T19:34:28.000Z

Please Can I have a french version !?

Answer 44 · 2024-04-01T14:11:46.000Z

@fchollet Hi, I think I invented something interesting. I implemented it in pytorch and I opened an issue there.
pytorch/pytorch#122680

Answer 45 · 2024-04-03T20:06:02.000Z

@vulkomilev How do you do the push to the branch?

you make a MR and waiting for approval

Answer 46 · 2024-04-03T20:13:32.000Z

@vulkomilev I cannot push. I don't have the rights.

Answer 47 · 2024-04-03T20:41:28.000Z

@vulkomilev I cannot push. I don't have the rights.

sorry I meant pull request

Answer 48 · 2024-04-22T18:54:22.000Z

Hello @fchollet,
Can I make the tool for saved Keras model file inspection, diff, and patching or is there someone already working on it?
Thanks in advance!

Answer 49 · 2024-04-22T20:41:48.000Z

I will get the "Add a new Flash Attention op" task

Answer 50 · 2024-04-23T16:54:37.000Z

@fchollet for every back-end I must introduce the implementation mentioned in the ticket right ?

Answer 51 · 2024-05-01T23:39:13.000Z

@sampathweb @fran6co - I have seen last comments on file 'keras/src/layers/preprocessing/string_lookup_test.py' . I have grep'ed for 'TODO' and list this file . I am new for Keras contrib and setup Keras in local successfully. Would any one give me insight on this file and changes needed for 'TODO' sections .