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

Add missing examples to contrib examples section. #792

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 3 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
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]*
*
vroulet marked this conversation as resolved.
Show resolved Hide resolved
```
10 changes: 6 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.9"
authors = [
{name = "DeepMind", email = "optax-dev@google.com"},
{name = "Google DeepMind", email = "optax-dev@google.com"},
]
keywords = [
"python",
Expand Down Expand Up @@ -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"
vroulet marked this conversation as resolved.
Show resolved Hide resolved
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
Loading