[PRE REVIEW]: ReadmeReady: Free and Customizable Code Documentation with LLMs - A Fine-Tuning Approach

[editorialbot]

Submitting author: @souradipp76 (Souradip Pal)
Repository: https://github.com/souradipp76/ReadMeReady
Branch with paper.md (empty if default branch): main
Version: v1.1.0
Editor: @crvernon
Reviewers: @Manvi-Agrawal, @camilochs
Managing EiC: Chris Vernon

Status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/279a09ad7a2963efe219581eba56bfb2"><img src="https://joss.theoj.org/papers/279a09ad7a2963efe219581eba56bfb2/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/279a09ad7a2963efe219581eba56bfb2/status.svg)](https://joss.theoj.org/papers/279a09ad7a2963efe219581eba56bfb2)

Author instructions

Thanks for submitting your paper to JOSS @souradipp76. Currently, there isn't a JOSS editor assigned to your paper.

@souradipp76 if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

[editorialbot]

Hello human, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.06 s (1020.4 files/s, 180140.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          34            961            445           5075
Jupyter Notebook                 2              0           1525            602
Markdown                        10            260              0            583
TeX                              1             36              1            283
YAML                             7             27             53            159
make                             1             16              4            102
Bourne Shell                     3             14              9             84
-------------------------------------------------------------------------------
SUM:                            58           1314           2037           6888
-------------------------------------------------------------------------------

Commit count by author:

    38	Sayak Chakrabarty
    35	Souradip Pal
    33	souradipp76
    32	souradip_pal
    17	hellokayas
    11	dependabot[bot]
     6	test

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 3874

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: Apache License 2.0 (Valid open source OSI approved license)

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1109/TIT.1956.1056813 is OK
- 10.1016/S1364-6613(03)00029-9 is OK
- 10.48550/arXiv.1410.5401 is OK
- 10.48550/arXiv.1409.0473 is OK
- 10.18653/v1/P16-1208 is OK
- 10.48550/arXiv.1603.06744 is OK
- 10.48550/arXiv.1704.01696 is OK
- 10.1109/MSR.2013.6624030 is OK
- 10.48550/arXiv.1611.08307 is OK
- 10.1109/ASE.2015.72 is OK
- 10.3115/v1/P15-1085 is OK
- 10.48550/arXiv.2005.14165 is OK
- 10.48550/arXiv.2203.02155 is OK
- 10.48550/arXiv.1706.03762 is OK
- 10.48550/arXiv.2104.08691 is OK
- 10.48550/arXiv.1707.02275 is OK
- 10.1109/TPAMI.2018.2889473 is OK
- 10.48550/arXiv.2305.14314 is OK
- 10.48550/arXiv.2106.09685 is OK
- 10.48550/arXiv.2305.13560 is OK
- 10.48550/arXiv.2311.05046 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Language models are unsupervised multitask learner...
- No DOI given, and none found for title: gpt-3.5-turbo
- No DOI given, and none found for title: gpt-4
- No DOI given, and none found for title: gpt-4-32k
- No DOI given, and none found for title: Llama-2-7B-Chat-GPTQ
- No DOI given, and none found for title: CodeLlama-7B-Instruct-GPTQ
- No DOI given, and none found for title: Llama-2-7b-chat-hf
- No DOI given, and none found for title: CodeLlama-7b-Instruct-hf
- No DOI given, and none found for title: gemma-2b-it
- No DOI given, and none found for title: codegemma-2b-it
- No DOI given, and none found for title: AutoDoc-ChatGPT
- No DOI given, and none found for title: AutoDoc
- No DOI given, and none found for title: Auto-GitHub-Docs-Generator
- No DOI given, and none found for title: Sentence Transformers: all-mpnet-base-v2

❌ MISSING DOIs

- None

❌ INVALID DOIs

- 10.1109/TCSS.2023.3248149 is INVALID

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[editorialbot]

Five most similar historical JOSS papers:

DeBEIR: A Python Package for Dense Bi-Encoder Information Retrieval
Submitting author: @ayuei
Handling editor: @arfon (Active)
Reviewers: @KonradHoeffner, @amitkumarj441
Similarity score: 0.6713

Jury: A Comprehensive Evaluation Toolkit
Submitting author: @devrimcavusoglu
Handling editor: @crvernon (Active)
Reviewers: @evamaxfield, @KennethEnevoldsen
Similarity score: 0.6668

TextDescriptives: A Python package for calculating a large variety of metrics from text
Submitting author: @HLasse
Handling editor: @fabian-s (Active)
Reviewers: @RichardLitt, @linuxscout
Similarity score: 0.6631

DeepSynth: Scaling Neural Program Synthesis with Distribution-based Search
Submitting author: @Theomat
Handling editor: @arfon (Active)
Reviewers: @njuaplusplus, @bzz
Similarity score: 0.6618

TRUNAJOD: A text complexity library to enhance natural language processing
Submitting author: @dpalmasan
Handling editor: @danielskatz (Active)
Reviewers: @mbdemoraes, @apiad
Similarity score: 0.6609

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[crvernon]

👋 @souradipp76 - thank you for your submission. While I am seeking out an editor for you, please reduce the word count of your paper to around 1000 words. Most non-essential items can be placed in your documentation. Thank you.

[souradipp76]

@crvernon, the paper has been modified to have a word count of around 1500. Thank you.

[Manvi-Agrawal]

Hi @crvernon , @souradipp76, I would like to review this paper. Can I go ahead?

Brief about me:
I am currently doing research on grammar inference using LLMs under Prof Miryung Kim at UCLA. I completed my masters in quantum from UCLA and undergrad in Computer Science from NSIT Delhi. Apart from this I have worked 2 years in Microsoft as a Software Engineer.

[crvernon]

@editorialbot assign me as editor

I am going to take this on myself as editor.

[editorialbot]

Assigned! @crvernon is now the editor

[crvernon]

@Manvi-Agrawal - may I ask how you heard about this review? Thanks!

[Manvi-Agrawal]

@crvernon I was browsing for open access journals on Wikipedia and came across JOSS. I found it interesting and went through JOSS website which directed me here.

[crvernon]

@editorialbot add @Manvi-Agrawal as reviewer

I'll add you @Manvi-Agrawal thanks!

[editorialbot]

@Manvi-Agrawal added to the reviewers list!

[crvernon]

👋 @camilochs - Would you be willing to review this submission to JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

[Manvi-Agrawal]

@editorialbot generate my checklist

[editorialbot]

Checklists can only be created once the review has started in the review issue

[crvernon]

@Manvi-Agrawal - I will start the actual review thread after I secure one more review. You will be able to generate your checklist from that thread.

[Manvi-Agrawal]

Thanks @crvernon for your quick reply. I was about to comment here regarding the same when I saw your reply xD

[camilochs]

👋 @camilochs - Would you be willing to review this submission to JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

Hello, @crvernon. Of course. I will review it during tomorrow.

[crvernon]

@editorialbot add @camilochs as reviewer

Thanks @camilochs!

[editorialbot]

@camilochs added to the reviewers list!

[crvernon]

@editorialbot start review

👋 - Alright @souradipp76, @Manvi-Agrawal, and @camilochs - I am going to close this Pre-Review and kick off the full review which you should receive a notification for. Thanks!

[editorialbot]

OK, I've started the review over in #7489.