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

Improve documentation #156

Closed
7 tasks
AlexeyG opened this issue Apr 1, 2020 · 4 comments
Closed
7 tasks

Improve documentation #156

AlexeyG opened this issue Apr 1, 2020 · 4 comments
Labels
Status: pull requests welcome We agree with the direction proposed, feel free to give it a shot and file a pull request

Comments

@AlexeyG
Copy link
Collaborator

AlexeyG commented Apr 1, 2020

Let's use this issue to collect all the places in which the documentation should be improved. If you think there's something missing from the list, please comment and we'll update the list.

As we work through this list, we'll update the description with links to PRs addressing each of the items.

  • nn.Collection
  • Module.apply
  • Module.call
  • Module should get a docstring
  • nn.stateful
  • nn.stochastic
  • Module.get_param (explain when it should be used)
@AlexeyG AlexeyG added the Status: pull requests welcome We agree with the direction proposed, feel free to give it a shot and file a pull request label Apr 1, 2020
@avital
Copy link
Contributor

avital commented Apr 23, 2020

Some of these documentation tasks may be best done as part some broader rethinking of core APIs, such as in #208

@avital
Copy link
Contributor

avital commented Apr 23, 2020

(And assessing how simple it is to write docstrings for new APIs will help make sure the APIs have a clear mental model)

@lisa-1010
Copy link
Contributor

https://github.com/google/flax/blob/master/flax/training/common_utils.py could benefit from docstrings, especially since the methods in it are used in many flax examples. Thanks!

@avital
Copy link
Contributor

avital commented Dec 12, 2020

I'll close this issue because it's related to the old flax.nn API and we've now switched to Linen.

@lisa-1010 I filed your comment about common_utils in a separate issue: #729

@avital avital closed this as completed Dec 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: pull requests welcome We agree with the direction proposed, feel free to give it a shot and file a pull request
Projects
None yet
Development

No branches or pull requests

3 participants