Skip to content

Conversation

@egenn
Copy link
Collaborator

@egenn egenn commented Oct 18, 2025

  • Removed the parameter_summary function from utils_rt.R.
  • Updated README to clarify the use of setup_() functions for configuration options.
  • Changed resampler_parameters to resampler_config in various function documentation and implementations.
  • Updated function signatures and documentation for clustering, decomposition, and preprocessing functions to use config instead of parameters.
  • Adjusted tests to reflect the changes from parameters to config in setup functions and clustering algorithms.
  • Updated all relevant documentation files to ensure consistency in naming conventions for configuration objects.

- Removed the `parameter_summary` function from `utils_rt.R`.
- Updated README to clarify the use of `setup_()` functions for configuration options.
- Changed `resampler_parameters` to `resampler_config` in various function documentation and implementations.
- Updated function signatures and documentation for clustering, decomposition, and preprocessing functions to use `config` instead of `parameters`.
- Adjusted tests to reflect the changes from `parameters` to `config` in setup functions and clustering algorithms.
- Updated all relevant documentation files to ensure consistency in naming conventions for configuration objects.
@egenn egenn requested a review from Copilot October 18, 2025 22:23
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 pull request performs a comprehensive refactoring to standardize terminology from "parameters" to "config" throughout the codebase. The main purpose is to improve naming consistency by using "config" for configuration objects while reserving "parameters" for actual function arguments.

Key changes include:

  • Renaming all *Parameters classes to *Config classes (e.g., TunerParametersTunerConfig)
  • Updating function signatures to use config instead of parameters for configuration objects
  • Renaming the parameter_summary utility function (removed entirely)

Reviewed Changes

Copilot reviewed 83 out of 83 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/testthat/test_*.R Updated test files to use new *Config class names and config parameter names
man/*.Rd Updated documentation files to reflect new class names and parameter terminology
R/*.R Core implementation files updated with new class names, method signatures, and consistent config terminology
README.md Updated to clarify setup functions provide "configuration options" instead of "parameters"
DESCRIPTION Version bump to reflect the refactoring changes

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment on lines +172 to 175
config = do_call(
get_clust_setup_fn(cluster),
cluster_params
cluster_config
)
Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

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

This will fail when cluster_config is NULL (the default value). Should add a null check or provide a default value like cluster_config %||% list(k = 2).

Copilot uses AI. Check for mistakes.
@gemini-code-assist
Copy link

Summary of Changes

Hello @egenn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant refactoring of how configuration options and parameters are handled throughout the package. The primary goal is to enhance code clarity and maintainability by standardizing naming conventions, moving from generic 'parameters' to more descriptive 'config' or 'hyperparams'. This change impacts class definitions, function signatures, and internal logic across multiple modules, ensuring a more intuitive and consistent interface for users and developers alike.

Highlights

  • Parameter Naming Standardization: The core change involves a comprehensive refactoring to rename 'parameters' to 'config' or 'hyperparams' across various classes, functions, and documentation for improved clarity and consistency.
  • Class and Method Renaming: Numerous S7 classes like PreprocessorParameters, ResamplerParameters, TunerParameters, ClusteringParameters, and DecompositionParameters have been renamed to their *Config counterparts, along with their associated methods and fields.
  • Documentation Updates: All relevant Roxygen documentation (.Rd files) and internal comments have been updated to reflect the new naming conventions, ensuring that the API and internal workings are consistently described.
  • Removal of parameter_summary: The parameter_summary utility function from utils_rt.R has been removed as part of the cleanup and refactoring effort.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a large-scale refactoring, renaming parameters to config across the codebase for better clarity and consistency. This affects numerous files, including class definitions, methods, function signatures, documentation, and tests. The changes are extensive but appear to be applied consistently for the most part. I've identified one minor naming inconsistency in R/13_S7_SuperConfig.R for your consideration. Overall, this is a great improvement for the codebase's consistency.

dat_test = class_character,
algorithm = class_character,
preprocessor = PreprocessorParameters | NULL,
preprocessor = PreprocessorConfig | NULL,

Choose a reason for hiding this comment

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

medium

For consistency with other changes in this pull request (e.g., tuner_config) and the argument in the train() function, consider renaming the preprocessor property to preprocessor_config.

    preprocessor_config = PreprocessorConfig | NULL,

@egenn
Copy link
Collaborator Author

egenn commented Oct 18, 2025

/gemini review

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request is a comprehensive refactoring to rename parameters to config across the codebase for better clarity and consistency. The changes are extensive, touching many files including source code, documentation, and tests. The refactoring appears to be very thorough and consistent. I have one minor suggestion regarding the version number update. Overall, this is a great improvement for the codebase's consistency.

DESCRIPTION Outdated
@@ -1,7 +1,7 @@
Package: rtemis
Version: 0.99.990
Version: 0.99.9100

Choose a reason for hiding this comment

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

medium

The new version 0.99.9100 seems a bit unusual. Is this a typo? Perhaps you meant 0.99.100 or 1.0.0? If the versioning scheme is intentional, feel free to ignore this comment.

@egenn egenn merged commit aca3f39 into main Oct 18, 2025
2 checks passed
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.

2 participants