SelfCode commited on
Commit
b04b040
·
verified ·
1 Parent(s): 7c442be

Upload reproduce/README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. reproduce/README.md +52 -0
reproduce/README.md ADDED
@@ -0,0 +1,52 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Reproduction guide
2
+
3
+ This directory contains the necessary information and assets to reproduce the results obtained during this Heretic run.
4
+
5
+ ## Models
6
+
7
+ - **Base model:** [Qwen/Qwen2.5-Coder-0.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-Coder-0.5B-Instruct) (Commit: [`ea3f247`](https://huggingface.co/Qwen/Qwen2.5-Coder-0.5B-Instruct/commit/ea3f2471cf1b1f0db85067f1ef93848e38e88c25))
8
+
9
+ ## Datasets
10
+
11
+ - [mlabonne/harmful_behaviors](https://huggingface.co/datasets/mlabonne/harmful_behaviors) (Commit: [`01cead0`](https://huggingface.co/datasets/mlabonne/harmful_behaviors/commit/01cead01398926d81f7c52bdb790ee8cf77ebba7))
12
+ - [mlabonne/harmless_alpaca](https://huggingface.co/datasets/mlabonne/harmless_alpaca) (Commit: [`02c6a92`](https://huggingface.co/datasets/mlabonne/harmless_alpaca/commit/02c6a92cfcf11bb0c387334f8146d149d65b587f))
13
+
14
+ ## Selected trial
15
+
16
+ - **Trial number:** 21
17
+ - **Refusals:** 7/100 (baseline: 51/100)
18
+ - **KL divergence:** 0.0289 (baseline: 0 *(by definition)*)
19
+
20
+ ## Environment
21
+
22
+ - **Heretic:** v2.0.0 (Origin: PyPI)
23
+ - **PyTorch:** 2.11.0+cu128
24
+ - **Other dependencies:** See [`requirements.txt`](requirements.txt).
25
+
26
+ ## Contents of this directory
27
+
28
+ - [`requirements.txt`](requirements.txt): The exact versions of all Python packages.
29
+ - [`config.toml`](config.toml): The exact configuration used, including the RNG seed.
30
+ - [`Qwen--Qwen2--5-Coder-0--5B-Instruct.jsonl`](Qwen--Qwen2--5-Coder-0--5B-Instruct.jsonl): The Optuna study journal containing the history of all trials.
31
+ - [`SHA256SUMS.txt`](SHA256SUMS.txt): Cryptographic hashes for all weight files.
32
+ - [`reproduce.json`](reproduce.json): A machine-readable file containing all reproducibility information.
33
+
34
+ ## How to reproduce
35
+
36
+ > [!TIP]
37
+ > You can automate this process, including all verification steps, by downloading the `reproduce.json` file and running
38
+ > `heretic --reproduce reproduce.json`.
39
+
40
+ 1. Install the exact version of Heretic indicated in the **Environment** section above, from its original source.
41
+ 1. Install the packages listed in `requirements.txt`: `pip install -r requirements.txt`
42
+ 1. Install the correct version of PyTorch: `pip install torch==2.11.0+cu128 --index-url https://download.pytorch.org/whl/cu128`
43
+ 1. Place the provided `config.toml` in your working directory.
44
+ 1. Run Heretic without any additional arguments: `heretic`
45
+ 1. Wait for the run to finish, then select trial **21** and export the model.
46
+ 1. Verify that the weight files have been exactly reproduced by comparing their SHA-256 hashes against those in `SHA256SUMS.txt`:
47
+ `sha256sum -c SHA256SUMS.txt` (or look at the hashes online if you uploaded to Hugging Face)
48
+
49
+ > [!TIP]
50
+ > To use the included Optuna study journal `Qwen--Qwen2--5-Coder-0--5B-Instruct.jsonl`, place it in the checkpoints directory (usually `checkpoints/`) before running Heretic.
51
+ >
52
+ > This allows you to export other models from the Pareto front, or to run additional trials without having to re-run the stored trials.