Skip to content

Add PyPI README files for toto-2, toto-models, and dd-unit-scaling#117

Merged
Salahidine2002 merged 2 commits into
mainfrom
salah/add-pypi-readmes
Jun 3, 2026
Merged

Add PyPI README files for toto-2, toto-models, and dd-unit-scaling#117
Salahidine2002 merged 2 commits into
mainfrom
salah/add-pypi-readmes

Conversation

@Salahidine2002

Copy link
Copy Markdown
Collaborator

What this does

Adds dedicated README.md files for the three packages that currently have no PyPI project description, and wires them up via the readme field in each pyproject.toml.

Without this, the PyPI pages for toto-2, toto-models, and dd-unit-scaling would show a blank project description after the upcoming releases.

Changes

  • toto2/README.md (new): focused package page with features, all 5 model weight links (HF), quick start snippet with inference tips, tutorial notebook links, GIFT-Eval/BOOM evaluation links, and Toto 2.0 citation
  • toto_models/README.md (new): lightweight umbrella page — explains what the package installs (table of toto-2, dd-unit-scaling, toto-ts), model weights table, links out to toto-2 for full docs
  • toto2/pyproject.toml: add readme = "README.md", also improved the one-liner description
  • toto_models/pyproject.toml: add readme = "README.md"
  • dd_unit_scaling/pyproject.toml: add readme = "README.md" (README already existed, just wasn't wired up)

Note on ../README.md

Pointing to the root README via ../README.md was considered but is explicitly forbidden by PEP 621 ("Parent directory indicators (..) must not be used"). Each package needs its own README inside its subdirectory.

Made with Cursor

- toto2/README.md: focused package page with features, all 5 model
  weight links, quick start, tutorials, evaluation links, and citation
- toto_models/README.md: lightweight umbrella page linking out to
  toto-2 for full docs, includes package table and model weight links
- Wire up readme = "README.md" in toto2/, toto_models/, and
  dd_unit_scaling/ pyproject.toml files so PyPI shows rich descriptions
  instead of blank project pages

Co-authored-by: Cursor <cursoragent@cursor.com>
@Salahidine2002 Salahidine2002 merged commit 44ea4e8 into main Jun 3, 2026
4 checks passed
@Salahidine2002 Salahidine2002 deleted the salah/add-pypi-readmes branch June 3, 2026 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants