Skip to content

Commit

Permalink
Add missing examples to contrib examples section.
Browse files Browse the repository at this point in the history
Also add flax as dependency to examples, which should
fix the error in

https://optax.readthedocs.io/en/latest/_collections/examples/mlp_mnist.html

remove dangling comment

Deepmind -> Google Deepmind

remove dangling spaces
  • Loading branch information
fabianp committed Feb 9, 2024
1 parent 2cdb89c commit 3e4065a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
1 change: 0 additions & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

This directory contains examples using the optax library.

<!-- include all files in the current directory except README.md -->
```{toctree}
:glob:
:maxdepth: 1
Expand Down
3 changes: 1 addition & 2 deletions examples/contrib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@

Examples that make use of the `optax.contrib` module.

<!-- include all files in the current directory except README.md -->
```{toctree}
:glob:
:maxdepth: 1
[!README.md]*
*
```
14 changes: 8 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.9"
authors = [
{name = "DeepMind", email = "[email protected]"},
{name = "Google DeepMind", email = "[email protected]"},
]
keywords = [
"python",
"machine learning",
"python",
"machine learning",
"reinforcement-learning"
]
classifiers = [
Expand All @@ -38,8 +38,8 @@ dependencies = [
]

[project.urls]
homepage = "https://github.com/deepmind/optax"
repository = "https://github.com/deepmind/optax"
homepage = "https://github.com/google-deepmind/optax"
repository = "https://github.com/google-deepmind/optax"
documentation = "https://optax.readthedocs.io/"

[project.optional-dependencies]
Expand All @@ -51,7 +51,8 @@ test = [
examples = [
"tensorflow-datasets>=4.2.0",
"tensorflow>=2.4.0",
"dp_accounting>=0.4"
"dp_accounting>=0.4",
"flax",
]

docs = [
Expand All @@ -66,6 +67,7 @@ docs = [
"sphinx-collections>=0.0.1",
"tensorflow>=2.4.0",
"tensorflow-datasets>=4.2.0",
"flax",
]

dp-accounting = [
Expand Down

0 comments on commit 3e4065a

Please sign in to comment.