README.md

---
title: Commit Message Editing Visualization
emoji: 📈
sdk: gradio
sdk_version: 4.37.2
app_file: change_visualizer.py
---

# Commit Message Editing Visualisation ✍️🔍📊

This space provides a visualization app for exploring the commit message edits datasets (🤗 [expert-labeled](https://huggingface.co/datasets/JetBrains-Research/commit-msg-edits) and 🤗 [synthetic](https://huggingface.co/datasets/JetBrains-Research/synthetic-commit-msg-edits))
from 📜 [Towards Realistic Evaluation of Commit Message Generation by Matching Online and Offline Settings](https://arxiv.org/abs/2410.12046) paper and also hosts important artifacts from our work.

## Artifacts

* 📊[`metrics_analysis.ipynb`](https://huggingface.co/spaces/JetBrains-Research/commit-message-editing-visualization/blob/main/metrics_analysis.ipynb) contains the code for metrics calculation and analysis;
* 📈[`chart.ipynb`](https://huggingface.co/spaces/JetBrains-Research/commit-message-editing-visualization/blob/main/chart.ipynb) contains the code for Figure 4 with edit distance distribution;
* 🗃️[`data_stats.ipynb`](https://huggingface.co/spaces/JetBrains-Research/commit-message-editing-visualization/blob/main/data_stats.ipynb) contains the code for obtaining the dataset statistics from Table 1;
* ⬅️[`generation_steps/synthetic_backward.py`](https://huggingface.co/spaces/JetBrains-Research/commit-message-editing-visualization/blob/main/generation_steps/synthetic_backward.py) contains the code for *Synthetic Backward* generation proposed in our paper;
* ➡️[`generation_steps/synthetic_forward.py`](https://huggingface.co/spaces/JetBrains-Research/commit-message-editing-visualization/blob/main/generation_steps/synthetic_forward.py) contains the code for *Synthetic Forward* generation proposed in our paper.

## Visualization

* 🔍 Click on `Examples Exploration` tab to browse through nicely-formatted examples from our dataset.
* 📈 Click on `Dataset Statistics` tab to see the major statistics for our dataset.
* 📊 Click on `Experimental Results` tab to see additional metrics tested as target online metrics alongside our main edit distance results.