Skip to content

Feature#32 - Fix windows install problem, update docs#42

Merged
emapuljak merged 3 commits into
masterfrom
feature#32-fix-windows-install-update-docs
Jun 15, 2026
Merged

Feature#32 - Fix windows install problem, update docs#42
emapuljak merged 3 commits into
masterfrom
feature#32-fix-windows-install-update-docs

Conversation

@emapuljak

@emapuljak emapuljak commented Jun 15, 2026

Copy link
Copy Markdown
Collaborator

Fix Windows installation & overhaul docs

Summary

Fixes the Windows installation failure caused by the transitive uvloop dependency, bumps the release to v1.1.0, and reworks the documentation (changelog, navbar structure, and landing page). Closes #32.

Why

On Windows, pip install tn4ml failed because orbax-checkpoint==0.11.33 (pulled in via flax) declared uvloop as an unconditional dependency, and uvloop ships no Windows wheels. The only workaround was pip install --no-deps tn4ml followed by manual dependency installation.

orbax-checkpoint==0.11.34 fixed this upstream by guarding the dependency with platform_system != "Windows".

Changes

Windows install fix

  • Pin orbax-checkpoint>=0.11.34 in setup.py so the resolver never selects the broken 0.11.33, and uvloop is correctly skipped on Windows. The --no-deps workaround is no longer needed.
  • Bump version 1.0.51.1.0.

Docs

  • Add docs/source/changelog.rst documenting all releases (v1.0.0 → v1.1.0), wired into the docs.
  • Restructure the navbar to four top-level items — Installation · API reference · Examples · Changelog — by grouping the modules under a new api.rst and the notebooks under a new examples.rst landing page.
  • Replace the empty docs home page with a meaningful landing page: intro, quickstart snippet, cross-links, and citation.
  • Update the install tag reference in README.md to v1.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-deps
  • sphinx-build -b html docs docs/build/html builds cleanly and the navbar shows the four expected items

@emapuljak emapuljak self-assigned this Jun 15, 2026
@emapuljak emapuljak merged commit 91fff09 into master Jun 15, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

pip install tn4ml fails on windows due to uvloop

1 participant