Chain-of-Embedding - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #golang #linux #docker #awesome #cli #awesome-list #security #mcp #ios #openai

Chain-of-Embedding

(★ 102)

[ICLR 2025] Code and Data Repo for Paper "Latent Space Chain-of-Embedding Enables Output-free LLM Self-Evaluation"

File Explorer

Download Latest Version (.zip)

- chain-of-embedding.png
- chain.png
- coe_insight.png
- definition.png
- feature.png
- belebele.jsonl
- commonsenseqa.jsonl
- load_data.py
- math.jsonl
- mgsm.jsonl
- theoremqa.jsonl
- eval.py
- match.py
- load_model.py
- llm_infer.sh
config_pool.py
inference.py
LICENSE
main.py
prompt_pool.py
README.md
requirements.txt
score.py

# Installation Guide

1. Get the code

git clone https://github.com/Alsace08/Chain-of-Embedding

Downloads the entire project code from GitHub to your computer.

cd Chain-of-Embedding

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python main.py

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## <center> <img src="./ASSETS/chain.png" width="3%" align="center"></img> Latent Space Chain-of-Embedding Enables Output-free LLM Self-Evaluation</center>

![Arxiv](https://img.shields.io/badge/Arxiv-2410.13640-red.svg?style=plastic)
![python 3.10](https://img.shields.io/badge/python-3.10-royalblue.svg?style=plastic)
![transformer 4.45](https://img.shields.io/badge/transformer-4.45-green.svg?style=plastic)
![license Apache-2.0](https://img.shields.io/badge/license-Apache%202.0-inactive.svg?style=plastic)

$\boxed{\text{Chain-of-Embedding (CoE)}}$ is a brand-new interpretability tool, which **captures a progressive embedding chain from input to output space** by tracking the hidden states of language models during inference.

<div align=center>
<img src="./ASSETS/chain-of-embedding.png" width="50%" align="center"></img>
</div>

***Definition***:
<div align=center>
<img src="./ASSETS/definition.png" width="90%" align="center"></img>
</div>

***Two CoE Features***:
<div align=center>
<img src="./ASSETS/feature.png" width="60%" align="center"></img>
</div>

***Insight***: When the language model responds correctly and incorrectly, the CoE in the latent space will produce differentiated representations.
<div align=center>
<img src="./ASSETS/coe_insight.png" width="90%" align="center"></img>
</div>

---

## *Usage Instruction*

We provide automated scripts in this repository to help you obtain inference-time **CoE scores** and **Visualization** of each sample.

## Environment Installation

```sh
conda create -n coeeval python=3.10
conda activate coeeval
pip install torch==2.3.1 torchvision==0.18.1 torchaudio==2.3.1 --index-url https://download.pytorch.org/whl/cu121
pip install -r requirements.txt
```

## Preparation

### 1. Model

To prevent instability in remote access, our code uses local model loading. You need to download the model you need to deploy (e.g., Llama-3-8B-Instruct) into the ``Model`` folder and add the name of the model folder to ``MODEL_POOL`` in ``config_pool.py``.

``Model/``

```sh
Model
  └── Llama-3-8B-Instruct ### add
      ├── config.json
      ├── model-00001-...
      ├── tokenizer_config.json
      └── ...
```

``config_pool.py``

```py
MODEL_POOL = [
        "Llama-3-8B-Instruct", ### add
    ]
```

*Note*: Our work is primarily focused on the **zero-shot paradigm for instruct-based models**. If using a base model, it may need to be modified to a few-shot paradigm.

### 2. Dataset

You need to add the dataset (``.jsonl`` format) to be tested into the ``Data`` folder (e.g. math).

``Data/``

```sh
Model
  └── math.jsonl ### add
```

Each sample must contain **at least the following keys and values**:

```py
{
  "id": 1, ### Unique identifier
  "en": "Find the units digit of $29 \\cdot 79 + 31 \\cdot 81$.", ### Question described in English
  "answer": "2" ### Standard answer without solution process
}
```

Similarly, please add the dataset name to ``DATASET_POOL`` in ``config_pool.py``.

``config_pool.py``

```py
DATASET_POOL = [
        "math", ### add
    ]
```

We also provide a multilingual interface. If you need to infer a multilingual version of a dataset, please first add the desired language list to ``LANGUAGE_MAPPING`` in ``config_pool.py``, and add question descriptions in the dataset file using the language names as keywords (refer to the mgsm dataset).

### 3. Instruction

The instructions corresponding to different datasets are stored under ``DATASET_PROMPTS`` in ``prompt_pool.py``. We provide instructions for all the datasets used in the paper, with some of them referencing <https://github.com/openai/simple-evals> and <https://github.com/open-compass/opencompass>.

``prompt_pool.py``

```py
DATASET_PROMPTS = {
    "mgsm": "Solve this math problem. Give the reasoning steps before giving the final answer on the last line by itself in the format of \"Answer:\". Do not add anything other than the integer answer after \"Answer:\".\n\nQuestion:\n{input_data}\n", ### add
}
```

*Note*: Please use **string parsing format** to facilitate automated parsing of input questions.

## Inference

```sh
bash Scripts/llm_infer.sh
```

Your can modify the following parameters in this script:

```sh
#!/bin/bash

export PROJECT_PATH="your/path/to/Chain-of-Embedding" ### your local path
export CUDA_VISIBLE_DEVICES="0,1" ### cuda id

model_name="qwen2-7B-Instruct" ### model name
dataset_list=(mgsm) ### dataset name (We provide a mode for cyclic testing across multiple datasets.)

for i in ${dataset_list[*]}; do
    python main.py --model_name $model_name \
                    --dataset "$i" \
                    ### The following are optional:
                    --print_model_parameter \
                    --save_output \
                    --save_hidden_states \
                    --save_coe_score \
                    --save_coe_figure
done
```

### Optional Parameters:

```print_model_parameter```: As described

```--save_output```: Save output (text sequence, perplexity, etc.) of each sample to ```./OutputInfo/{language}/Output/{model}/{dataset}/{dataset}_{sample_id}.pkl```

```--save_hidden_states```: Save hidden states corresponding to each output token at each layer of each sample to ```./OutputInfo/{language}/HiddenStates/{model}/{dataset}/{dataset}_{sample_id}.pkl```

```--save_coe_score```: Save CoE Score of each sample to ```./OutputInfo/{language}/CoE/{model}/{dataset}/{dataset}_{sample_id}.pkl```

```--save_coe_figure```: Draw the CoE trajectory of each sample to ```./Figure/{language}/{model}/{dataset}/{dataset}_{sample_id}.pkl```

### Core CoE Score Computation

In ```score.py```.

## Citation

If you use our technique or are inspired by our work, welcome to cite our paper and provide valuable suggestions.

```
@article{wang2024latent,
  title={Latent Space Chain-of-Embedding Enables Output-free LLM Self-Evaluation},
  author={Wang, Yiming and Zhang, Pei and Yang, Baosong and Wong, Derek F and Wang, Rui},
  journal={arXiv preprint arXiv:2410.13640},
  year={2024}
}
```