Skip to content

Commit 0be7b99

Browse files
committed
start the repo with the readme
0 parents  commit 0be7b99

3 files changed

Lines changed: 84 additions & 0 deletions

File tree

.github/workflows/reveal.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: reveal
2+
on:
3+
schedule:
4+
- cron: "45 16 * * *"
5+
workflow_dispatch:
6+
permissions:
7+
contents: write
8+
jobs:
9+
reveal:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
with:
14+
fetch-depth: 0
15+
- name: release the next piece from the vault branch
16+
run: |
17+
set -e
18+
START="2026-08-07"
19+
TODAY=$(date -u +%Y-%m-%d)
20+
if [[ "$TODAY" < "$START" ]]; then echo "not started until $START"; exit 0; fi
21+
git config user.name "Arunendra21"
22+
git config user.email "156455722+Arunendra21@users.noreply.github.com"
23+
git fetch --depth=1 origin vault:refs/remotes/origin/vault
24+
order=(figures source_code ieee_report.docx ieee_report.pdf presentation.pptx outputs processing_notes.md)
25+
next=""
26+
for it in "${order[@]}"; do
27+
if git cat-file -e refs/remotes/origin/vault:"$it" 2>/dev/null && [ ! -e "$it" ]; then next="$it"; break; fi
28+
done
29+
if [ -z "$next" ]; then echo "everything already released"; exit 0; fi
30+
git checkout refs/remotes/origin/vault -- "$next"
31+
case "$next" in
32+
figures) MSG="add the generated figures";;
33+
source_code) MSG="add the reproduction source code";;
34+
ieee_report.docx) MSG="add the write-up";;
35+
ieee_report.pdf) MSG="add the write-up as pdf";;
36+
presentation.pptx) MSG="add the summary slides";;
37+
outputs) MSG="add the metrics and outputs";;
38+
processing_notes.md) MSG="add the processing notes";;
39+
*) MSG="add $next";;
40+
esac
41+
git add "$next"
42+
git commit -m "$MSG"
43+
git push origin HEAD:main

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
__pycache__/
2+
*.pyc
3+
*.pyo
4+
.DS_Store
5+
.ipynb_checkpoints/
6+
original_paper.pdf

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Sorting-and-Prediction Integrated High-Capacity RDH (Li 2026)
2+
3+
This repo is my reproduction of Sorting-and-Prediction Integrated High-Capacity RDH, from Jian Li, Lingxiao Bo, Miaomiao Yang, Bin Ma, Shijun Xiang, Xiaolong Li, Zhenxing Qian, published in IEEE Trans. Consumer Electronics (early access), 2026.
4+
5+
It predicts each pixel from its neighbours and expands the small prediction errors to carry data with very little distortion.
6+
7+
I reimplemented the method from the paper and ran it from start to finish. Every number and every figure in the report is produced by the code in this repo, and reversibility is checked to be bit exact wherever the method claims it.
8+
9+
## Running it
10+
11+
Everything runs with plain Python and a handful of common libraries. From this folder:
12+
13+
```bash
14+
cd source_code
15+
python3 run_experiment.py # runs the method, writes metrics and figures
16+
python3 build_deliverables.py # rebuilds the IEEE report and the slides
17+
```
18+
19+
You need numpy, scipy, matplotlib, pillow, python-docx and python-pptx. Install them with `pip install numpy scipy matplotlib pillow python-docx python-pptx`. The report is exported to PDF with headless LibreOffice, so that has to be on the machine if you want the PDF rebuilt.
20+
21+
## What sits in this folder
22+
23+
```
24+
(the original paper stays on my machine and is not republished here, to respect its copyright)
25+
ieee_report.docx/.pdf my IEEE format reproduction report
26+
presentation.pptx a short summary deck
27+
source_code/ the scripts that do the actual work
28+
outputs/ metrics.json and the raw numbers behind the report
29+
figures/ the plots and images the code produces
30+
processing_notes.md what was reproduced, what was not, and the caveats
31+
```
32+
33+
## A note on honesty
34+
35+
Nothing in the tables or plots was copied from the paper. Anything marked as reported, and only that, is quoted from the original for comparison. Everything else is computed here. Where the exact image set or an unstated hyperparameter differs from the paper, the absolute figures can move a little, but the behaviour and the reversibility hold. The specifics for this paper are in `processing_notes.md`.

0 commit comments

Comments
 (0)