Skip to content

Document Hugging Face dataset download helper - #545

Merged
anth-volk merged 1 commit into
masterfrom
fix-351-document-huggingface-download
Sep 8, 2026
Merged

anth-volk merged 1 commit into
masterfrom
fix-351-document-huggingface-download

Conversation

@anth-volk

Copy link
Copy Markdown
Collaborator

Fixes #351

Summary

  • Document the Hugging Face repository identifier, repository-relative file path, revision, and local destination accepted by download_huggingface_dataset.
  • Document that the function returns the downloaded file's local path.
  • Correct the helper's nullable revision, destination path, repository-privacy, and authentication-token annotations without changing runtime behavior.
  • Add the required changelog fragment.

Verification

  • UV_PYTHON=3.13 uv run ruff format --check policyengine_core/tools/hugging_face.py
  • UV_PYTHON=3.13 uv run ruff check policyengine_core/tools/hugging_face.py
  • UV_PYTHON=3.13 uv run mypy --config-file mypy.ini policyengine_core/tools/hugging_face.py
  • UV_PYTHON=3.13 uv run pytest tests/core/tools/test_hugging_face.py -q (15 passed)

Documentation review

  • Documentation change: the public helper's source documentation now specifies its complete input and output contract; no separate guide or generated artifact changes are required.
  • Impact: low. This changes annotations and documentation only.
  • Confidence: high, based on focused tests, formatting, linting, and static typing.
  • Known gaps: none.

@anth-volk
anth-volk marked this pull request as ready for review September 8, 2026 12:48
@anth-volk
anth-volk merged commit 6378d47 into master Sep 8, 2026
18 checks passed
@anth-volk
anth-volk deleted the fix-351-document-huggingface-download branch September 8, 2026 12: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.

Add documentation to download_huggingface_dataset util function

1 participant