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

editorialbot commented 2 days ago

Submitting author: !--author-handle-->@souradipp76@crvernon<!--end-editor-- Reviewers: @Manvi-Agrawal, @camilochs Archive: Pending

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)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@Manvi-Agrawal & @camilochs, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review. First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @crvernon know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

📝 Checklist for @Manvi-Agrawal

editorialbot commented 2 days ago

Hello humans, 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 commented 2 days ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.06 s (1047.7 files/s, 184202.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          34            961            445           5075
Markdown                        11            297              0            680
Jupyter Notebook                 2              0           1525            602
TeX                              1             36              1            283
YAML                             7             27             53            159
make                             1             16              4            102
Bourne Shell                     3             14              9             84
-------------------------------------------------------------------------------
SUM:                            59           1351           2037           6985
-------------------------------------------------------------------------------

Commit count by author:

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

editorialbot commented 2 days ago

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.1109/TCSS.2023.3321345 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

- None

crvernon commented 2 days ago

👋 @souradipp76, @Manvi-Agrawal, and @camilochs - This is the review thread for the paper. All of our communications will happen here from now on.

Please read the "Reviewer instructions & questions" in the first comment above.

Both reviewers have checklists at the top of this thread (in that first comment) with the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention https://github.com/openjournals/joss-reviews/issues/7489 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for the review process to be completed within about 4-6 weeks but please make a start well ahead of this as JOSS reviews are by their nature iterative and any early feedback you may be able to provide to the author will be very helpful in meeting this schedule.

editorialbot commented 2 days ago

Paper file info:

📄 Wordcount for paper.md is 1625

✅ The paper includes a Statement of need section

editorialbot commented 2 days ago

License info:

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

editorialbot commented 2 days ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

Manvi-Agrawal commented 1 day ago

Review checklist for @Manvi-Agrawal

Conflict of interest

[x] I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the https://github.com/souradipp76/ReadMeReady?
[x] License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
[ ] Contribution and authorship: Has the submitting author (@souradipp76) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
[ ] Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
[ ] Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
[ ] Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
[ ] Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

[ ] Installation: Does installation proceed as outlined in the documentation?
[ ] Functionality: Have the functional claims of the software been confirmed?
[ ] Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[ ] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[ ] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[ ] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[ ] Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
[ ] Community guidelines: Are there clear guidelines for third parties wishing to 1. Contribute to the software 2. Report issues or problems with the software 3. Seek support

Software paper

[ ] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
[ ] A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
[ ] State of the field: Do the authors describe how this software compares to other commonly-used packages?
[ ] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
[ ] References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Manvi-Agrawal commented 1 day ago

@editorialbot generate pdf

editorialbot commented 1 day ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

Manvi-Agrawal commented 1 day ago

Hi @souradipp76, I did a high-level pass and left an initial review. I would appreciate more insights into how to reproduce the results and run readme-ready locally for non OpenAI models(I exhausted my free credits xD). After you provide with these details, I can do another round of review.

openjournals / joss-reviews