Change Typing to follow Jax best practice #543
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…/jax.readthedocs.io/en/latest/jax.typing.html). General guideline: - `ArrayLike` and `ArrayLikeTree` to annotate function input, - `Array` and `ArrayTree` to annotate function output. Leaves of a Pytree definition in the library are in principle annotated as `Array`, as they are mostly internal representation. For example: ``` class WelfordAlgorithmState(NamedTuple): mean: Array ... ``` Something I am not happy about is the way `logdensity` is annotated. While they are `Array` (as they are in most cases should be output of a Jax function), we annotate them as `float` to empathizes they should be scalar. I am leaving them as `float` for now until we introduce shape annotation.
This reverts commit 3e4923a.
Codecov Report
@@ Coverage Diff @@
## main #543 +/- ##
=======================================
Coverage 99.14% 99.14%
=======================================
Files 49 49
Lines 2094 2099 +5
=======================================
+ Hits 2076 2081 +5
Misses 18 18
|
albcab
approved these changes
Jun 12, 2023
junpenglao
added a commit
that referenced
this pull request
Mar 12, 2024
Update typing in the library following current best practice (https://jax.readthedocs.io/en/latest/jax.typing.html). General guideline: - `ArrayLike` and `ArrayLikeTree` to annotate function input, - `Array` and `ArrayTree` to annotate function output. Leaves of a Pytree definition in the library are in principle annotated as `Array`, as they are mostly internal representation. For example: ``` class WelfordAlgorithmState(NamedTuple): mean: Array ... ``` Something I am not happy about is the way `logdensity` is annotated. While they are `Array` (as they are in most cases should be output of a Jax function), we annotate them as `float` to empathizes they should be scalar. I am leaving them as `float` for now until we introduce shape annotation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update typing in the library following current best practice.
General guideline:
ArrayLikeandArrayLikeTreeto annotate function input,ArrayandArrayTreeto annotate function output.Leaves of a Pytree definition in the library are in principle annotated as
Array, as they are mostly internal representation. For example:Something I am not happy about is the way
logdensityis annotated. While they areArray(as they are in most cases should be output of a Jax function), we annotate them asfloatto empathizes they should be scalar. I am leaving them asfloatfor now until we introduce shape annotation.