Skip to content

Commit

Permalink
Clarify inclusion criteria into optax and optax.contrib
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 602960170
  • Loading branch information
fabianp authored and OptaxDev committed Jan 31, 2024
1 parent dff5020 commit a1f4ef7
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/api/contrib.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
🔧 Contrib
===============

Experimental features and algorithms that don't meet the
:ref:`inclusion_criteria`.

.. currentmodule:: optax.contrib

.. autosummary::
Expand Down
15 changes: 15 additions & 0 deletions docs/contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,21 @@ Some more details on contributing code are provided in the
[CONTRIBUTING.md](https://github.com/deepmind/optax/blob/main/CONTRIBUTING.md)
file in the source tree.


(inclusion_criteria)=
## Inclusion Criteria

We only consider well-established algorithms for inclusion in the main `optax`
package. A rule of thumb is at least 2 years since publication, 100+ citations,
and wide usefulness. A small modification of an existing algorithm that provides
a clear-cut improvement on a widely-used method will also be considered for
inclusion.

Algorithms that don't meet these criteria should instead be submitted to the
{doc}`api/contrib` directory. When in doubt, we recommend submitting new
algorithms to this directory.


#### Design Documents

For more complex or involved features, we recommend starting out by writing a
Expand Down

0 comments on commit a1f4ef7

Please sign in to comment.