Skip to content

Add readme for downloading model weights. #33

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add readme for downloading model weights. #33

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
20 changes: 20 additions & 0 deletions openpmcvl/granular/checkpoints/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# PMC Helper Model Checkpoints

These checkpoints contain helper models used in creating the PMC-2M dataset.

## Download Weights

Make sure to run this script before using the pipeline.

```python
from huggingface_hub import snapshot_download

weights_dir = snapshot_download(
repo_id="vector-institute/pmc-helper-models",
local_dir="openpmcvl/granular/checkpoints",
allow_patterns=["*.pt", "*.pth"]
)
```

The weights will be downloaded to the specified `local_dir`. Your existing code can then load them from this location.
Change the `local_dir` to the path of the directory leading to `openpmcvl/granular/checkpoints` in your project.