Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use sphinx-contributors for an automated contributors list. #841

Merged
merged 1 commit into from
Mar 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ def new_process_docstring(app, what, name, obj, options, lines):
'coverage_check',
'myst_nb', # This is used for the .ipynb notebooks
'sphinx_gallery.gen_gallery',
'sphinxcontrib.collections'
'sphinxcontrib.collections',
'sphinx_contributors'
]

# so we don't have to do the canonical imports on every doctest
Expand Down
24 changes: 11 additions & 13 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,24 +69,22 @@ You generally only need to submit a CLA once, so if you've already submitted one
again.


## Core Maintainers
## The Team

* [Iurii Kemaev](https://github.com/hbq1)
* [Markus Kunesch](https://github.com/mkunesch)
* [Matteo Hessel](https://github.com/mtthss)
* [Ross Hemsley](https://github.com/rosshemsley)
Optax is developed by a team of researchers at Google DeepMind and Alphabet, as well as a growing community of open-source contributors. The work on Optax is part of a wider effort to contribute to making the [JAX Ecosystem](https://deepmind.google/discover/blog/using-jax-to-accelerate-our-research/) the best possible environment for ML/AI research. Below is the list of the top (in number of commits) 30 contributors to date:

## Collaborators

We'd also like to extend a special thanks to the following open source
contributors who have made significant contributions to Optax,
{role-name}`contributors`

* [n2cholas](https://github.com/n2cholas)
* [wdphy16](https://github.com/wdphy16)
* [holounic](https://github.com/holounic)
```{eval-rst}
.. contributors:: google-deepmind/optax
:avatars:
:limit: 30
:order: ASC
```

A full list of the contributors to date can be found [here](https://github.com/deepmind/optax/graphs/contributors).

A full list of open source contributors can be found
[here](https://github.com/deepmind/optax/graphs/contributors).

## Community Guidelines

Expand Down
19 changes: 2 additions & 17 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,31 +68,16 @@ for instructions on installing JAX.
api/contrib


The Team
--------

The development of Optax is led by Ross Hemsley, Matteo Hessel, Markus Kunesch
and Iurii Kemaev. The team relies on outstanding contributions from Research
Engineers and Research Scientists from throughout
`Google DeepMind <https://deepmind.google/discover/blog/using-jax-to-accelerate-our-research/>`_
and Alphabet. We are also very grateful to Optax's open source community for
contributing ideas, bug fixes, issues, design docs, and amazing new features.

The work on Optax is part of a wider effort to contribute to making the
`JAX Ecosystem <https://deepmind.google/discover/blog/using-jax-to-accelerate-our-research/>`_
the best possible environment for ML/AI research.

Support
-------

If you are having issues, please let us know by filing an issue on our
`issue tracker <https://github.com/google-deepmind/optax/issues>`_.
If you encounter issues with this software, please let us know by filing an issue on our `issue tracker <https://github.com/google-deepmind/optax/issues>`_. We are also happy to receive bug fixes and other contributions. For more information of how to contribute, please see the `development guide <development>`_.


License
-------

Optax is licensed under the Apache 2.0 License.
Optax is licensed under the `Apache 2.0 License <https://github.com/google-deepmind/optax/blob/main/LICENSE>`_.


Indices and Tables
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ docs = [
"tensorflow>=2.4.0",
"tensorflow-datasets>=4.2.0",
"flax",
"sphinx_contributors",
]

dp-accounting = [
Expand Down
Loading