Skip to content

README cleanup: trim icons, collapse BibTeX, soften pricing, footer#277

Merged
noahho merged 10 commits into
mainfrom
noahho-patch-1
May 12, 2026
Merged

README cleanup: trim icons, collapse BibTeX, soften pricing, footer#277
noahho merged 10 commits into
mainfrom
noahho-patch-1

Conversation

@noahho
Copy link
Copy Markdown
Collaborator

@noahho noahho commented May 12, 2026

README cleanup for the client. No code changes.

  • Collapses the Development / Release sections into a single <details> toggle under ## Development. Content (pre-commit setup, build-from-source, PyPI release flow) is preserved verbatim; just hidden behind a click so the top-level README stays scannable.
  • Strips emoji icons from the H2 headers (Stable Release, TabPFN Ecosystem, Quick Start, Authentication, Join Our Community, Usage Limits, Citation, License).
  • Collapses the BibTeX block under a <details> toggle in the Citation section so it doesn't dominate the page when expanded.
  • Aligns Citation with PriorLabs/TabPFN: adds the missing grinsztajn2025tabpfn (TabPFN-2.5 model report) entry plus the intro sentence linking both papers. Client previously only had the Nature paper + the original ICLR 2023 paper.
  • Removes the "Best Results" subsection under Quick Start — the extensions advice belongs in the TabPFN repo, not the client.
  • Rewrites API Cost Calculation: drops the explicit pricing formula, the hard-coded 100M/day limit, and the stale "fill out this form" link in favour of a qualitative description ("cost grows with rows and columns") and a single pointer to ux.priorlabs.ai/api/usage for live usage.
  • Renames Access/Delete Personal Information to Access/Delete Data.
  • Adds a "Built with ❤️ by the TabPFN community" footer matching the convention in PriorLabs/tabpfn-extensions.

@noahho noahho requested a review from brendan-priorlabs May 12, 2026 08:13
@noahho noahho requested a review from a team as a code owner May 12, 2026 08:13
@chatgpt-codex-connector
Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request removes the 'License', 'Development', and 'Release' sections from the README.md file. The reviewer noted that these sections contain vital information for contributors and maintainers regarding environment setup and the release process, and recommended retaining them or moving them to a separate file like CONTRIBUTING.md.

I am having trouble creating individual review comments. Click here to see my feedback.

README.md (204-271)

medium

The removal of the 'License', 'Development', and 'Release' sections significantly reduces the documentation available for contributors and maintainers. These sections contain vital information regarding the project's licensing, environment setup (ruff, pre-commit), and the release process. If these details are being moved to a separate file (e.g., CONTRIBUTING.md), please ensure that file is included in this pull request. Otherwise, it is recommended to retain these sections to maintain project transparency and ease of contribution.

noahho and others added 3 commits May 12, 2026 11:05
Matches the treatment in PriorLabs/TabPFN#954.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Drops the ✅/🌐/🏁/🔑/🤝/📊/📚 icons from the section headers.
- Adds the TabPFN-2.5 bibtex entry + intro line so Citation matches
  the canonical version in PriorLabs/TabPFN.
- Removes the Best Results subsection (extensions advice belongs in
  the TabPFN repo / docs, not the client).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Drops the explicit pricing formula in favour of a qualitative
description so the README isn't load-bearing for the v3 formula
constants. Updates the limits to the new defaults (50M daily,
200M monthly) and points at the live usage page rather than
just response headers.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@noahho noahho requested a review from dianaprior May 12, 2026 09:08
noahho and others added 4 commits May 12, 2026 11:12
The original PR pruning accidentally dropped the License section
alongside the Development/Release blocks. License (Apache 2.0)
is genuine user-facing info and should stay.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Matches the convention used in PriorLabs/tabpfn-extensions.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Limits change server-side independently of releases; the live usage
page is now the source of truth.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@noahho noahho changed the title Update README.md README cleanup: trim icons, collapse BibTeX, soften pricing, footer May 12, 2026
Copy link
Copy Markdown
Collaborator

@brendan-priorlabs brendan-priorlabs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please keep the release stuff? I use that all the time

Copy link
Copy Markdown
Collaborator

@brendan-priorlabs brendan-priorlabs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above

@noahho
Copy link
Copy Markdown
Collaborator Author

noahho commented May 12, 2026

Release stuff should live somewhere internal, I'll add it back and we think of where it should go next

noahho and others added 2 commits May 12, 2026 11:42
Per review feedback: the build-from-source and pypi-release instructions
are useful and should stay, but they don't belong inline in the public
README. Tucking them behind a single <details> toggle keeps the
top-level README scannable while preserving the content.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@noahho noahho enabled auto-merge May 12, 2026 09:46
Copy link
Copy Markdown
Collaborator

@brendan-priorlabs brendan-priorlabs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Yes, agreed

@noahho noahho added this pull request to the merge queue May 12, 2026
Merged via the queue into main with commit ecb0d09 May 12, 2026
6 checks passed
@noahho noahho deleted the noahho-patch-1 branch May 12, 2026 09:48
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