Feature#32 - Fix windows install problem, update docs#42
Merged
Conversation
This file contains hidden or 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
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.
Fix Windows installation & overhaul docs
Summary
Fixes the Windows installation failure caused by the transitive
uvloopdependency, bumps the release to v1.1.0, and reworks the documentation (changelog, navbar structure, and landing page). Closes #32.Why
On Windows,
pip install tn4mlfailed becauseorbax-checkpoint==0.11.33(pulled in viaflax) declareduvloopas an unconditional dependency, anduvloopships no Windows wheels. The only workaround waspip install --no-deps tn4mlfollowed by manual dependency installation.orbax-checkpoint==0.11.34fixed this upstream by guarding the dependency withplatform_system != "Windows".Changes
Windows install fix
orbax-checkpoint>=0.11.34insetup.pyso the resolver never selects the broken0.11.33, anduvloopis correctly skipped on Windows. The--no-depsworkaround is no longer needed.1.0.5→1.1.0.Docs
docs/source/changelog.rstdocumenting all releases (v1.0.0 → v1.1.0), wired into the docs.api.rstand the notebooks under a newexamples.rstlanding page.README.mdtov1.1.0.Versioning note
Released as 1.1.0 (minor, not a patch): this line also removed the hardcoded
softmax(changes model output/evaluation) and dropped Python < 3.10 support — both beyond a bug fix.Testing
pip install .succeeds on Windows without--no-depssphinx-build -b html docs docs/build/htmlbuilds cleanly and the navbar shows the four expected items