google-deepmind / google-deepmind/optax

New Example on creating a custom `GradientTransformation`

Open
#652 2 comments 0 reactions 1 assignee Claimed by @SauravMaheshkar View on GitHub
documentation type:feature
Dominant language
Python
Stars
2.3k
Forks
369
Avg merge
10h 15m
Merged PRs (30d)
7

Description

### Motivation

Recently for a personal project (#641) I wanted to created a custom `GradientTransformation` object and found out that there wasn't a tutorial or walkthrough on how to create one. While the ["Gradient Transformations"](https://github.com/google-deepmind/optax#gradient-transformations-transformpy) section in the `README.md` section was somewhat helpful, I still had to look around and search for example implementations in other repositories and within the `contrib` sub-package.

### Proposal

Create a new example or a page in the documentation containing instructions on how to create a custom `GradientTransformation` object.

---

Happy to contribute and work on this.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.