YourIdentity's picture
Upload reproduce/README.md with huggingface_hub
df677fb verified
|
Raw
History Blame
3.17 kB

Reproduction guide

This directory contains the necessary information and assets to reproduce the results obtained during this Heretic run.

Local code

This system installed Heretic from a local directory or wheel. Uncommitted or experimental code may have been executed.

Reproducibility cannot be guaranteed in this environment.

Models

Datasets

Selected trial

  • Trial number: 191
  • Refusals: 6/100 (baseline: 99/100)
  • KL divergence: 0.0307 (baseline: 0 (by definition))

Environment

  • Heretic: v2.0.0.dev0 (Origin: Local)
  • PyTorch: 2.14.0+cu132
  • Other dependencies: See requirements.txt.

Contents of this directory

How to reproduce

You can automate this process, including all verification steps, by downloading the reproduce.json file and running heretic --reproduce reproduce.json.

  1. Install the exact version of Heretic indicated in the Environment section above, from its original source.
  2. Install the packages listed in requirements.txt: pip install -r requirements.txt
  3. Install the correct version of PyTorch: pip install torch==2.14.0+cu132 --index-url https://download.pytorch.org/whl/cu132
  4. Place the provided config.toml in your working directory.
  5. Run Heretic without any additional arguments: heretic
  6. Wait for the run to finish, then select trial 191 and export the model.
  7. 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)

To use the included Optuna study journal openbmb--MiniCPM5-2B.jsonl, place it in the checkpoints directory (usually checkpoints/) before running Heretic.

This allows you to export other models from the Pareto front, or to run additional trials without having to re-run the stored trials.