[Doc 1] Add AI-gen documentation to espnetez#6241
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a substantial amount of AI-generated documentation to the espnetez package, significantly enhancing code clarity and maintainability. A key addition is a new script for automatically generating docstrings using LLMs. The changes also enable flake8 in CI and include various code style improvements. My review primarily focuses on the quality of the new documentation, and I have identified a couple of areas where the generated content is either incorrect or has formatting issues that impact readability.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #6241 +/- ##
==========================================
- Coverage 56.49% 56.49% -0.01%
==========================================
Files 896 896
Lines 84820 84814 -6
==========================================
- Hits 47920 47914 -6
Misses 36900 36900
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@Masao-Someki, can you check the espnetez part? |
Masao-Someki
left a comment
There was a problem hiding this comment.
Thank you, I’ve reviewed the documents. For files like __init__.py, I think it’s good to include scripts within the same package.
| datasets. The structure can be either: | ||
| ``{"train": {...}, "valid": {...}}`` or a flat mapping where the same | ||
| items are used for both splits. Each value must be a tuple | ||
| ``(file_name, name, type)``. |
There was a problem hiding this comment.
I think it's good to link where we can find the types.
espnet/espnet2/train/dataset.py
Line 248 in eaf9a83
|
@Masao-Someki Thank you for the comments. |
sw005320
left a comment
There was a problem hiding this comment.
OK for me.
If @Masao-Someki approves, we can merge this PR.
Note
Adding documentation using LLMs to activate flake8 test in espnetez and espnet2.
For espnet2, I will divide as much as possible because I observed more than 1K of issues related to missing documentation.
What did you change?
This pull request focuses on code quality improvements, documentation formatting, and minor dependency updates across several scripts and configuration files. The main themes are: (1) code style and formatting consistency, (2) enhancements to documentation tooling and configuration, and (3) minor dependency and CI workflow adjustments.
Code style and formatting consistency:
doc/argparse2rst.py,doc/convert_custom_tags_to_html.py,doc/convert_md_to_homepage.py, anddoc/make_release_note_from_milestone.py, making the codebase more consistent and readable. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17]Documentation tooling and configuration:
doc/conf.pyto ensure proper imports, theme configuration, and string formatting for Sphinx documentation, improving compatibility and appearance. [1] [2] [3] [4] [5] [6] [7]Dependency and CI workflow adjustments:
libjpeg-devto the Dockerfile dependencies and commented out the Miniconda installation block, likely to streamline the build process or address build issues. (.devcontainer/ci_cpu/espnet.dockerfile) [1] [2]flake8andpycodestylelinting in CI scripts to enforce code quality standards. [1] [2]These changes collectively improve maintainability, readability, and the developer experience for the project.