dilim/heretic
1
0 Fork 0
mirror of https://github.com/p-e-w/heretic.git synced 2026-11-06 05:16:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: rename reproduce checksum file to SHA256SUMS.txt (#479)

Browse Source 
* fix: rename reproduce checksum file to SHA256SUMS.txt

Hugging Face renders relative links without a file extension as
directory links (/tree/), so the SHA256SUMS link in the reproduce
README opened a 404. Giving the file a .txt extension keeps the link
relative while making it open as a file, like the other reproduce
assets. The verification instruction becomes sha256sum -c SHA256SUMS.txt.

Fixes #463

* test: remove reproduce folder tests
This commit is contained in:
Matt Van Horn authored and GitHub committed 2026-10-31 14:57:28 +05:30
1 parent 6e9e397933
commit d16e020116
1 file changed
+5 -5
Download Patch File Download Diff File Expand all files Collapse all files
src/heretic/utils.py
+5 -5
View File
@@ -582,7 +582,7 @@ This directory contains the necessary information and assets to reproduce the re
- [`requirements.txt`](requirements.txt): The exact versions of all Python packages.
- [`config.toml`](config.toml): The exact configuration used, including the RNG seed.
- [`{checkpoint_filename}`]({checkpoint_filename}): The Optuna study journal containing the history of all trials.
- [`SHA256SUMS`](SHA256SUMS): Cryptographic hashes for all weight files.
- [`SHA256SUMS.txt`](SHA256SUMS.txt): Cryptographic hashes for all weight files.
- [`reproduce.json`](reproduce.json): A machine-readable file containing all reproducibility information.
## How to reproduce
@@ -597,8 +597,8 @@ This directory contains the necessary information and assets to reproduce the re
1. Place the provided `config.toml` in your working directory.
1. Run Heretic without any additional arguments: `heretic`
1. Wait for the run to finish, then select trial **{trial.user_attrs["index"]}** and export the model.
1. Verify that the weight files have been exactly reproduced by comparing their SHA-256 hashes against those in `SHA256SUMS`:
`sha256sum -c SHA256SUMS` (or look at the hashes online if you uploaded to Hugging Face)
1. Verify that the weight files have been exactly reproduced by comparing their SHA-256 hashes against those in `SHA256SUMS.txt`:
`sha256sum -c SHA256SUMS.txt` (or look at the hashes online if you uploaded to Hugging Face)
> [!TIP]
> To use the included Optuna study journal `{checkpoint_filename}`, place it in the checkpoints directory (usually `checkpoints/`) before running Heretic.
@@ -655,7 +655,7 @@ def generate_reproduce_json(
def generate_sha256sums(hashes: dict[str, str]) -> str:
"""Generates GNU Coreutils compatible SHA256SUMS file content."""
"""Generates GNU Coreutils compatible content for SHA256SUMS.txt."""
lines = []
@@ -711,7 +711,7 @@ def create_reproduce_folder(
)
if uploaded_model_hashes:
(reproduce_dir / "SHA256SUMS").write_text(
(reproduce_dir / "SHA256SUMS.txt").write_text(
generate_sha256sums(uploaded_model_hashes),
encoding="utf-8",
)