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

Added How_JAX_primitives_work colab #1423

Merged
merged 5 commits into from
Oct 7, 2019
Merged

Added How_JAX_primitives_work colab #1423

merged 5 commits into from
Oct 7, 2019

Conversation

gnecula
Copy link
Collaborator

@gnecula gnecula commented Oct 2, 2019

This addresses in part issue #116.

@gnecula
Copy link
Collaborator Author

gnecula commented Oct 2, 2019

@shoyer: Should this go into doc/notebooks or in notebooks/. I am not sure what criterion you use to decide this.

@gnecula gnecula requested a review from froystig October 2, 2019 13:51
@gnecula
Copy link
Collaborator Author

gnecula commented Oct 2, 2019

@shoyer
Copy link
Collaborator

shoyer commented Oct 2, 2019

There's no particular reason why we need to put notebooks in the "notebooks" subdirectory. I think the docs build will work fine with them anywhere inside the docs directory.

One thing I do recommend is being careful with your use of top level (#) and lower level (##, ###, etc) headings. The style of the docs pages tends to makes these a bit more noticible than colab, so check your table of contents first to make you have the right hierarchy.

@shoyer
Copy link
Collaborator

shoyer commented Oct 2, 2019

Oh. I see now that you were asking about docs/notebooks vs notebooks :).

I don't think there is any official policy, but my inclination would be to move over everything into the docs, whch I find to be much easier to navigate/browse. The only reason why I didn't do everything is that it takes a bit of tweaking to make notebooks look good after migrating, and I hadn't gotten around to it.

@gnecula
Copy link
Collaborator Author

gnecula commented Oct 2, 2019

What do I need to do to make sure that the Colab looks good (other than aligning the use of # with the other colabs)?

@shoyer
Copy link
Collaborator

shoyer commented Oct 2, 2019

You can run a docs build locally if you want to check it first... or we can just merge this (once we're happy with the content) and check/fix the formatting once it builds automatically after the merge.

* Cleaned up use of section levels
* Renamed ma to multiply_add and sq_add to square_add
* Other minor clarifications
* Separated the Colabs into Tutorials and Advanced Tutorials
Copy link
Collaborator

@shoyer shoyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

gnecula and others added 2 commits October 4, 2019 11:56
Co-Authored-By: James Bradbury <jekbradbury@google.com>
Co-Authored-By: James Bradbury <jekbradbury@google.com>
@gnecula gnecula merged commit a5063ee into jax-ml:master Oct 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants