Skip to content

feat: allow pinning HuggingFace revision for default checkpoint download #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Berkkirik wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: allow pinning HuggingFace revision for default checkpoint download #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion opf/_common/checkpoint_download.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from __future__ import annotations

import os
from pathlib import Path
import shutil
import sys
Expand All @@ -9,6 +10,8 @@


DEFAULT_HF_MODEL_REPO: Final[str] = "openai/privacy-filter"
DEFAULT_HF_MODEL_REVISION: Final[str | None] = None
HF_MODEL_REVISION_ENV_VAR: Final[str] = "OPF_HF_REVISION"


def _checkpoint_override_message() -> str:
Expand Down Expand Up @@ -104,17 +107,20 @@ def ensure_default_checkpoint() -> str:
f"{_checkpoint_override_message()}."
) from exc

revision = os.environ.get(HF_MODEL_REVISION_ENV_VAR) or DEFAULT_HF_MODEL_REVISION
try:
revision_suffix = f" (revision={revision!r})" if revision else ""
print(
"Default OPF checkpoint not found at "
f"{target}. Downloading from HuggingFace repo "
f"{DEFAULT_HF_MODEL_REPO!r} to {target}.",
f"{DEFAULT_HF_MODEL_REPO!r}{revision_suffix} to {target}.",
file=sys.stderr,
flush=True,
)
try:
snapshot_download(
repo_id=DEFAULT_HF_MODEL_REPO,
revision=revision,
local_dir=str(target),
tqdm_class=_build_download_progress_class(),
allow_patterns=["original/*"],
Expand Down