Lauarvik commited on
Commit
4a86f78
·
verified ·
1 Parent(s): f5b0ee3

Upload reproduce/README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. reproduce/README.md +72 -0
reproduce/README.md ADDED
@@ -0,0 +1,72 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Reproduction guide
2
+
3
+ This directory contains the necessary information and assets to reproduce the results obtained during this Heretic run.
4
+ > [!IMPORTANT]
5
+ > **Git installation**
6
+ >
7
+ > This system installed Heretic from a Git repository: https://github.com/p-e-w/heretic.git @ ebb5e651df4be58d05cb4f28652e65d725e845eb
8
+ >
9
+ > To reproduce the model, you must install Heretic from this exact repository and commit.
10
+
11
+
12
+ ## Models
13
+
14
+ - **Base model:** [ibm-granite/granite-4.1-8b](https://huggingface.co/ibm-granite/granite-4.1-8b) (Commit: [`7bb65b7`](https://huggingface.co/ibm-granite/granite-4.1-8b/commit/7bb65b75d368ccbb06c64278225da88dca40871c))
15
+
16
+ ## Datasets
17
+
18
+ - **Good prompts:** [mlabonne/harmless_alpaca](https://huggingface.co/datasets/mlabonne/harmless_alpaca) (Commit: [`02c6a92`](https://huggingface.co/datasets/mlabonne/harmless_alpaca/commit/02c6a92cfcf11bb0c387334f8146d149d65b587f))
19
+ - **Bad prompts:** [mlabonne/harmful_behaviors](https://huggingface.co/datasets/mlabonne/harmful_behaviors) (Commit: [`01cead0`](https://huggingface.co/datasets/mlabonne/harmful_behaviors/commit/01cead01398926d81f7c52bdb790ee8cf77ebba7))
20
+ - **Good evaluation prompts:** [mlabonne/harmless_alpaca](https://huggingface.co/datasets/mlabonne/harmless_alpaca) (Commit: [`02c6a92`](https://huggingface.co/datasets/mlabonne/harmless_alpaca/commit/02c6a92cfcf11bb0c387334f8146d149d65b587f))
21
+ - **Bad evaluation prompts:** [mlabonne/harmful_behaviors](https://huggingface.co/datasets/mlabonne/harmful_behaviors) (Commit: [`01cead0`](https://huggingface.co/datasets/mlabonne/harmful_behaviors/commit/01cead01398926d81f7c52bdb790ee8cf77ebba7))
22
+
23
+ ## Selected trial
24
+
25
+ - **Trial number:** 7
26
+ - **KL divergence:** 0.064686
27
+ - **Refusals:** 1/100
28
+
29
+ ## System
30
+
31
+ - **Python:** 3.12.12 (CPython, GCC 11.4.0) [System]
32
+ - **Operating system:** Linux-6.6.113+-x86_64-with-glibc2.35 (x86_64)
33
+ - **CPU:** Intel(R) Xeon(R) CPU @ 2.00GHz
34
+
35
+ ### Accelerators
36
+
37
+ - **CUDA:** Detected 2 device(s) (29.12 GB total VRAM)
38
+ - **CUDA Version:** 12.8
39
+ - **Driver Version:** 580.105.08
40
+ - **Devices:**
41
+ - **CUDA 0:** Tesla T4 (14.56 GB)
42
+ - **CUDA 1:** Tesla T4 (14.56 GB)
43
+
44
+ ## Environment
45
+
46
+ - **Heretic:** v1.2.0 (Origin: Git (https://github.com/p-e-w/heretic.git @ ebb5e651df4be58d05cb4f28652e65d725e845eb))
47
+ - **PyTorch:** 2.10.0+cu128
48
+ - **Other dependencies:** See [`requirements.txt`](requirements.txt).
49
+
50
+ ## Contents of this directory
51
+
52
+ - [`requirements.txt`](requirements.txt): The exact versions of all Python packages.
53
+ - [`config.toml`](config.toml): The exact configuration used, including the RNG seed.
54
+ - [`ibm-granite--granite-4--1-8b.jsonl`](ibm-granite--granite-4--1-8b.jsonl): The Optuna study journal containing the history of all trials.
55
+ - [`SHA256SUMS`](SHA256SUMS): Cryptographic hashes for all weight files.
56
+ - [`reproduce.json`](reproduce.json): A machine-readable file containing all reproducibility information.
57
+
58
+ ## How to reproduce
59
+
60
+ 1. Ensure your system matches the specifications in the **System** section above. Exact reproducibility is only guaranteed if all aspects of your system are identical to the one the model was originally generated on.
61
+ 1. Install the exact version of Heretic indicated in the **Environment** section above, from its original source.
62
+ 1. Install the packages listed in `requirements.txt`: `pip install -r requirements.txt`
63
+ 1. Install the correct version of PyTorch: `pip install torch==2.10.0+cu128 --index-url https://download.pytorch.org/whl/cu128`
64
+ 1. Place the provided `config.toml` in your working directory.
65
+ 1. Run Heretic without any additional arguments: `heretic`
66
+ 1. Wait for the run to finish, then select trial **7** and export the model.
67
+ 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)
68
+
69
+ > [!TIP]
70
+ > To use the included Optuna study journal `ibm-granite--granite-4--1-8b.jsonl`, place it in the checkpoints directory (usually `checkpoints/`) before running Heretic.
71
+ >
72
+ > This allows you to export other models from the Pareto front, or to run additional trials without having to re-run the stored trials.