Skip to content

Conversation

@ramosv
Copy link
Member

@ramosv ramosv commented May 29, 2025

  • Jupyter Notebooks outputs updated to improve readability
  • More competencies review and update of .rst
  • updated non working hyperlinks

Copy link

Copilot AI left a 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_clinical column handling and adjusted logging levels, hyperparameter options, and resource settings in dpmon.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_selected including ignored columns but returns df_features[selected_columns] instead of df_selected; update the return to return df_selected.
return df_features[selected_columns]

Copy link
Collaborator

@abdelhafizm abdelhafizm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ramosv ramosv requested a review from abdelhafizm May 29, 2025 21:53
@ramosv
Copy link
Member Author

ramosv commented May 29, 2025

@abdelhafizm please review again and merge when all checks pass.

Copy link
Collaborator

@abdelhafizm abdelhafizm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better

@abdelhafizm abdelhafizm merged commit b5e7d93 into main May 29, 2025
27 checks passed
@ramosv ramosv deleted the improve-readability-of-documentation branch July 31, 2025 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants