Skip to content

Clarify Hub case-data inventory semantics - #310

Open
LittleLeaf1018 wants to merge 4 commits into
dynamicslab:mainfrom
LittleLeaf1018:codex/hydrogym-hub-directory-semantics
Open

LittleLeaf1018 wants to merge 4 commits into
dynamicslab:mainfrom
LittleLeaf1018:codex/hydrogym-hub-directory-semantics

Conversation

@LittleLeaf1018

@LittleLeaf1018 LittleLeaf1018 commented Oct 14, 2026 •

Copy link
Copy Markdown

Direct-to-main documentation correction, based on upstream main at 4ab9854dea3d84e38a59c25e0f5835a00cf8225f. The PR changes four documentation files and contains no commits from #284.

Changes

  • Remove aggregate environment totals and per-backend counts from README, quickstart, introduction, and docs/CLAUDE.md.
  • In the README, retain 89 only as a revision-bound count of top-level Hub case-data directories.
  • Explain that this directory inventory does not establish distinct runtime-instantiable environments, solver availability, validation, or backend coverage.
  • Document loader APIs by backend: MAIA maia.from_hf(...) and NEK NekEnv.from_hf(..., nproc=...); qualify download and offline-staging behavior by backend.

Source evidence

  • Dataset revision cf5ef6748443ae72e9647f398487e98d421a7243 contains 89 top-level directories. The sorted directory-ID list SHA-256 is f05df1a337de060151b945a463ca9b5b7e6b3e5cc211433830f9518f1f661fb9.
  • At HydroGym main commit 4ab9854dea3d84e38a59c25e0f5835a00cf8225f, HFDataManager.get_available_environments() calls list_repo_files() without a revision and returns unique first path components; it does not instantiate or execute those entries: source lines 354–371.
  • The loader examples are checked against the pinned MAIA and NEK sources and their backend guides.

Validation

  • git diff --check passes.
  • Recounted the public Hub tree at the pinned revision with huggingface_hub 1.6.0; 1,471 nested file paths yield 89 top-level directory IDs.
  • npm ci and npm run build pass in an isolated checkout. npm ci reports 60 audit findings in the existing lockfile; this change does not modify dependencies.
  • GitHub reports no checks on the branch.

PR #284 remains a separate open draft that also touches these count claims. Maintainers should coordinate the overlapping documentation changes so the Hub directory inventory is not presented as runtime environment coverage.

@LittleLeaf1018
LittleLeaf1018 force-pushed the codex/hydrogym-hub-directory-semantics branch from e6f96cc to d14df3f Compare October 14, 2026 06:57
@LittleLeaf1018
LittleLeaf1018 changed the base branch from stack-02-phase1-dead-code-cleanup to main October 14, 2026 06:57
@LittleLeaf1018
LittleLeaf1018 marked this pull request as ready for review October 14, 2026 13:16

This branch has not been deployed

No deployments
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.

1 participant