From a1f4ef73c0847b43c2ba41962f7c015aa4ee0260 Mon Sep 17 00:00:00 2001 From: Fabian Pedregosa Date: Wed, 31 Jan 2024 00:22:46 -0800 Subject: [PATCH] Clarify inclusion criteria into optax and optax.contrib PiperOrigin-RevId: 602960170 --- docs/api/contrib.rst | 3 +++ docs/contributors.md | 15 +++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/api/contrib.rst b/docs/api/contrib.rst index 01d41984..e3ad826f 100644 --- a/docs/api/contrib.rst +++ b/docs/api/contrib.rst @@ -1,6 +1,9 @@ 🔧 Contrib =============== +Experimental features and algorithms that don't meet the +:ref:`inclusion_criteria`. + .. currentmodule:: optax.contrib .. autosummary:: diff --git a/docs/contributors.md b/docs/contributors.md index 217cb8b5..d1b4e160 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -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