[JAX/version] Support adding custom version suffix. #24861
+21
−6
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
jakevdp
reviewed
Nov 12, 2024
jax/version.py
Outdated
| @@ -60,7 +60,8 @@ def _version_from_git_tree(base_version: str) -> str | None: | |||
| except: | |||
| return None | |||
| else: | |||
| return f"{base_version}.dev{datestring}+{commit_hash}" | |||
| version_suffix = os.environ.get("JAX_CUSTOM_VERSION_SUFFIX", "") | |||
| return f"{base_version}.dev{datestring}+{commit_hash}+{version_suffix}" | |||
There was a problem hiding this comment.
Not sure about the whole PR, but one quick observation: this looks to be incompatible with PEP 440 version specifications: the local version (everything after the first +) should only contain alphanumeric characters or periods, not another + (see https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers)
There was a problem hiding this comment.
Thank you. I change "+" -> "." and I guess from what Gemini gives me, it conforms to the standard.
hawkinsp
reviewed
Nov 16, 2024
yliu120
force-pushed
the
add_versions
branch
from
1c18fe9
to
1fcb544
Compare
Done. |
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.
This PR attempts to add a custom version suffix for JAX dev builds.
The versioning is important when people want to hash the compilation result of the JIT program. The users can use whatever local version of XLA repo and pass a version suffix constructed on their own side as part of the hash key.
This will greatly enhance the cache key especially when developers are doing dev builds based on different commits or local change.