Skip to content

Commit a6027dc

Browse files
avirajkhare00avirajkhare00
committed
Add JOSS and arXiv submission package
1 parent 17f9741 commit a6027dc

8 files changed

Lines changed: 390 additions & 0 deletions

File tree

‎CITATION.cff‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
cff-version: 1.2.0
2+
title: Transformer Runtime Lab
3+
message: "If you use this repository, please cite the software artifact."
4+
type: software
5+
authors:
6+
- family-names: Khare
7+
given-names: Aviraj
8+
affiliation: Independent Researcher, Satna, Madhya Pradesh, India
9+
repository-code: "https://github.com/avirajkhare00/transformer-in-notion"
10+
license: Apache-2.0
11+
version: 0.1.0
12+
date-released: 2026-03-18
13+
abstract: >-
14+
Browser-local exact execution with problem-shaped virtual machines, including
15+
exact runtimes, local model guidance, and interactive artifacts for Sudoku,
16+
invoice total extraction, Tally-style voucher extraction, and related tasks.
17+
preferred-citation:
18+
type: article
19+
authors:
20+
- family-names: Khare
21+
given-names: Aviraj
22+
title: Problem-Shaped Virtual Machines for Exact Local Transformer Execution
23+
year: 2026
24+
url: "https://github.com/avirajkhare00/transformer-in-notion/blob/main/docs/paper-idea-problem-shaped-vms.pdf"

‎README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,19 @@ In practice that means:
3333

3434
The model handles ambiguity by scoring branches. The code handles truth.
3535

36+
## Citation
37+
38+
If you use the repository as a software artifact, cite:
39+
40+
- [CITATION.cff](/Users/avirajkhare/hack2/transformers/transformer-in-notion/CITATION.cff)
41+
- [paper.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.md)
42+
- [paper.pdf](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.pdf)
43+
44+
If you want the broader research-paper framing rather than the software-paper
45+
framing, use:
46+
47+
- [docs/paper-idea-problem-shaped-vms.pdf](/Users/avirajkhare/hack2/transformers/transformer-in-notion/docs/paper-idea-problem-shaped-vms.pdf)
48+
3649
## Why this approach
3750

3851
Generic compiled traces are too noisy for narrow exact tasks. They include machine detail the task does not care about:

‎docs/arxiv-submission-package.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# arXiv Submission Package
2+
3+
## Purpose
4+
5+
This document tracks the material needed for the full research-paper track on
6+
arXiv.
7+
8+
Primary manuscript:
9+
10+
- [paper-idea-problem-shaped-vms.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/docs/paper-idea-problem-shaped-vms.md)
11+
- [paper-idea-problem-shaped-vms.tex](/Users/avirajkhare/hack2/transformers/transformer-in-notion/docs/paper-idea-problem-shaped-vms.tex)
12+
- [paper-idea-problem-shaped-vms.pdf](/Users/avirajkhare/hack2/transformers/transformer-in-notion/docs/paper-idea-problem-shaped-vms.pdf)
13+
14+
Companion spec:
15+
16+
- [psvm-yellow-paper.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/docs/psvm-yellow-paper.md)
17+
- [psvm-yellow-paper.pdf](/Users/avirajkhare/hack2/transformers/transformer-in-notion/docs/psvm-yellow-paper.pdf)
18+
19+
## Recommended arXiv metadata
20+
21+
- Title:
22+
`Problem-Shaped Virtual Machines for Exact Local Transformer Execution`
23+
- Author:
24+
`Aviraj Khare`
25+
- Affiliation:
26+
`Independent Researcher, Satna, Madhya Pradesh, India`
27+
- Primary category:
28+
likely `cs.AI` or `cs.LG`
29+
- Secondary categories:
30+
likely `cs.SE`, `cs.PL`, or `cs.IR`
31+
32+
## Abstract source
33+
34+
Use the abstract from:
35+
36+
- [paper-idea-problem-shaped-vms.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/docs/paper-idea-problem-shaped-vms.md)
37+
38+
## Submission notes
39+
40+
- arXiv should carry the broad research claim and experiments
41+
- the JOSS paper should stay software-centered and shorter
42+
- the arXiv paper should cite the repository and, once available, the JOSS DOI
43+
44+
## Before submission
45+
46+
- confirm author name and affiliation are final
47+
- verify all figures and tables are original or properly attributed
48+
- add a related-work matrix to the manuscript
49+
- add a limitations / non-claims section if not already present
50+
- make sure README links to the paper and spec remain current

‎docs/joss-release-plan.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# JOSS Release and Tag Plan
2+
3+
## Goal
4+
5+
Create a stable, citable software artifact for the JOSS submission.
6+
7+
## Recommended release version
8+
9+
- release version: `v0.1.0`
10+
- release title: `Transformer Runtime Lab v0.1.0`
11+
- release purpose: first JOSS submission artifact
12+
13+
## Why a release is needed
14+
15+
JOSS evaluates a specific software artifact, not only a moving repository head.
16+
The submission package should therefore point to:
17+
18+
- a fixed git tag
19+
- a GitHub release
20+
- an archived release with a DOI
21+
22+
## Recommended sequence
23+
24+
1. Make sure `main` contains the final submission files:
25+
- [paper.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.md)
26+
- [paper.bib](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.bib)
27+
- [paper.pdf](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.pdf)
28+
- [CITATION.cff](/Users/avirajkhare/hack2/transformers/transformer-in-notion/CITATION.cff)
29+
2. Tag the release:
30+
31+
```bash
32+
git tag -a v0.1.0 -m "JOSS submission release"
33+
git push origin v0.1.0
34+
```
35+
36+
3. Create the GitHub release from that tag.
37+
4. Archive the tagged release with Zenodo or Figshare to mint a DOI.
38+
5. If a DOI is minted, update:
39+
- [CITATION.cff](/Users/avirajkhare/hack2/transformers/transformer-in-notion/CITATION.cff)
40+
- [paper.bib](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.bib)
41+
- [paper.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.md)
42+
6. Regenerate [paper.pdf](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.pdf) if metadata changes.
43+
44+
## Suggested release description
45+
46+
Use wording close to:
47+
48+
> First software release for JOSS submission. This release freezes the
49+
> repository state for the `Transformer Runtime Lab` software paper and the
50+
> browser-local PSVM demos for Sudoku, invoice total extraction, Tally-style
51+
> voucher extraction, and Weiqi.
52+
53+
## Metadata to verify before tagging
54+
55+
- author name: `Aviraj Khare`
56+
- affiliation: `Independent Researcher, Satna, Madhya Pradesh, India`
57+
- citation key for software artifact: `@khare2026trl`
58+
- citation key for broad research paper: `@khare2026paper`
59+
60+
## Not in scope for the release tag itself
61+
62+
- changing the broad research-paper thesis
63+
- rewriting the arXiv paper substantially
64+
- adding new demos or major features
65+
66+
Freeze the software artifact first. Expand the broader paper afterward if
67+
needed.

‎docs/joss-submission-checklist.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# JOSS Submission Checklist
2+
3+
## Paper package
4+
5+
- [x] JOSS paper source at [paper.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.md)
6+
- [x] bibliography at [paper.bib](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.bib)
7+
- [x] generated JOSS paper PDF at [paper.pdf](/Users/avirajkhare/hack2/transformers/transformer-in-notion/paper.pdf)
8+
- [x] software-focused framing rather than a pure theory framing
9+
- [x] AI usage disclosure included
10+
11+
## Repository basics
12+
13+
- [x] open-source license in [LICENSE](/Users/avirajkhare/hack2/transformers/transformer-in-notion/LICENSE)
14+
- [x] public repository with runnable demos
15+
- [x] top-level README
16+
- [x] dedicated [CITATION.cff](/Users/avirajkhare/hack2/transformers/transformer-in-notion/CITATION.cff)
17+
- [x] short citation section in [README.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/README.md)
18+
- [x] multiple working examples: Sudoku, invoice, Tally, Weiqi
19+
20+
## Still worth tightening before JOSS submission
21+
22+
- [ ] add explicit versioned release for the submission artifact
23+
- [ ] archive the release with a DOI provider such as Zenodo or Figshare
24+
- [ ] verify installation instructions from a clean machine
25+
- [ ] make sure at least one minimal automated smoke path is documented end to end
26+
- [ ] consider a short architecture figure for the JOSS paper README and docs
27+
- [ ] replace placeholder version/date values if the submission release changes
28+
29+
## Framing guidance
30+
31+
The JOSS paper should sell this repository as:
32+
33+
- software
34+
- AI
35+
- systems
36+
- artifact
37+
38+
It should not try to prove the entire research thesis inside the JOSS paper.
39+
That broader argument belongs in the arXiv paper:
40+
41+
- [paper-idea-problem-shaped-vms.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/docs/paper-idea-problem-shaped-vms.md)
42+
43+
## Suggested software citation keys
44+
45+
- repository / software artifact: `@khare2026trl`
46+
- broad research paper / preprint: `@khare2026paper`
47+
48+
## Immediate next steps
49+
50+
1. create the tagged release described in [joss-release-plan.md](/Users/avirajkhare/hack2/transformers/transformer-in-notion/docs/joss-release-plan.md)
51+
2. archive that release and mint a DOI
52+
3. run a clean-start install check
53+
4. document a minimal automated smoke path
54+
5. do one final prose pass after the release metadata is frozen

‎paper.bib‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
@misc{khare2026trl,
2+
author = {Khare, Aviraj},
3+
title = {Transformer Runtime Lab},
4+
year = {2026},
5+
publisher = {GitHub},
6+
url = {https://github.com/avirajkhare00/transformer-in-notion},
7+
note = {Open-source repository accessed 2026-03-18}
8+
}
9+
10+
@misc{khare2026paper,
11+
author = {Khare, Aviraj},
12+
title = {Problem-Shaped Virtual Machines for Exact Local Transformer Execution},
13+
year = {2026},
14+
howpublished = {Preprint draft in repository},
15+
url = {https://github.com/avirajkhare00/transformer-in-notion/blob/main/docs/paper-idea-problem-shaped-vms.pdf},
16+
note = {Repository-backed research paper draft accessed 2026-03-18}
17+
}
18+
19+
@misc{ortools,
20+
author = {{Google OR-Tools Team}},
21+
title = {OR-Tools},
22+
year = {2026},
23+
url = {https://developers.google.com/optimization},
24+
note = {Open-source software library for optimization}
25+
}
26+
27+
@article{pysat,
28+
author = {Ignatiev, Alexey and Morgado, António and Marques-Silva, Joao},
29+
title = {PySAT: A Python Toolkit for Prototyping with SAT Oracles},
30+
journal = {SAT 2018},
31+
year = {2018},
32+
doi = {10.1007/978-3-319-94144-8_26}
33+
}
34+
35+
@misc{transformersjs,
36+
author = {Boreiko, Xenova},
37+
title = {Transformers.js},
38+
year = {2026},
39+
url = {https://github.com/huggingface/transformers.js},
40+
note = {Machine learning for the web}
41+
}
42+
43+
@misc{onnxruntime,
44+
author = {{Microsoft}},
45+
title = {ONNX Runtime},
46+
year = {2026},
47+
url = {https://onnxruntime.ai/},
48+
note = {Cross-platform inference runtime}
49+
}
50+
51+
@article{layoutparser,
52+
author = {Shen, Zejiang and Zhang, Ruochen and Dell, Melissa and Lee, Benjamin Charles Germain and Carlson, Jacob and Li, Weining},
53+
title = {LayoutParser: A Unified Toolkit for Deep Learning Based Document Image Analysis},
54+
journal = {International Conference on Document Analysis and Recognition},
55+
year = {2021},
56+
doi = {10.1007/978-3-030-86331-9_7}
57+
}

0 commit comments

Comments
 (0)