-
Notifications
You must be signed in to change notification settings - Fork 2
Modified .rst files and jupyter notebooks to improve readability #67
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
ramosv
commented
May 29, 2025
- Jupyter Notebooks outputs updated to improve readability
- More competencies review and update of .rst
- updated non working hyperlinks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances documentation readability across .rst files, updates development dependencies, and refines preprocessing and downstream-task code behavior.
- Streamlined and reformatted documentation in
utils.rst,metrics.rst,index.rst, and Sphinx config. - Added a new build dependency and updated autosummary exports.
- Refactored
preprocess_clinicalcolumn handling and adjusted logging levels, hyperparameter options, and resource settings indpmon.py.
Reviewed Changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| requirements-dev.txt | Added the build package |
| docs/source/utils.rst | Reformatted function listings and examples for clarity |
| docs/source/metrics.rst | Updated examples, ASCII tables, and code snippets |
| docs/source/index.rst | Simplified installation section and reordered TOC entries |
| docs/source/conf.py | Enabled custom CSS by moving html_css_files |
| docs/source/_autosummary/bioneuralnet.utils.preprocess.rst | Exported OrdinalEncoder in the autosummary |
| bioneuralnet/utils/preprocess.py | Modified column concatenation logic and added (unused) import |
| bioneuralnet/downstream_task/dpmon.py | Changed log levels, hyperparameter ranges, and CPU allocation |
Comments suppressed due to low confidence (1)
bioneuralnet/utils/preprocess.py:103
- The function builds a
df_selectedincluding ignored columns but returnsdf_features[selected_columns]instead ofdf_selected; update the return toreturn df_selected.
return df_features[selected_columns]
abdelhafizm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
|
@abdelhafizm please review again and merge when all checks pass. |
abdelhafizm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
better