Flexibility improvements#19
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR implements flexibility improvements to the DAIndex framework by adding better access methods for step analysis, configurable decision boundaries, and improved documentation.
- Added new methods to access step sample information, sub-optimal steps, and failed steps for individual groups and all groups
- Introduced configurable decision boundary parameter for DA curve calculations
- Enhanced documentation with better method descriptions and parameter explanations
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tutorials/meps_tutorial.ipynb | Updated tutorial to demonstrate new API methods and configuration options |
| pyproject.toml | Version bump from 0.7.3 to 0.8.0 |
| daindex/util.py | Enhanced documentation for area_under_curve function |
| daindex/main.py | Added new methods for accessing step information and renamed existing methods for consistency |
| .pre-commit-config.yaml | Reordered pre-commit hooks configuration |
Comments suppressed due to low confidence (2)
daindex/main.py:500
- [nitpick] The variable name
sub_opt_stepsuses an abbreviation. Consider using the full namesub_optimal_stepsfor consistency with the class attribute naming pattern.
sub_opt_steps = {s[0]: s[1] for s in ret if s[3]}
daindex/main.py:508
- [nitpick] The variable name
sub_opt_listuses an abbreviation. Consider usingsub_optimal_listfor consistency with the method naming pattern.
sub_opt_list = ", ".join([f"{s[0]}: {s[1]}" for s in ret if s[3]])
Comment on lines
+144
to
+145
| The results can be accessed using the `get_group_ratio` and `get_group_figure` methods (with a reference and | ||
| other group), or printed using the `present_results` and `present_all_results` methods. |
There was a problem hiding this comment.
The documentation update refers to get_group_ratios and get_group_figures as renamed methods, but should clarify that these are the new method names replacing the old ones to avoid confusion.
Suggested change
| The results can be accessed using the `get_group_ratio` and `get_group_figure` methods (with a reference and | |
| other group), or printed using the `present_results` and `present_all_results` methods. | |
| The results can be accessed using the `get_group_ratios` and `get_group_figures` methods (with a reference and | |
| other group). These are the new method names replacing the old `get_group_ratio` and `get_group_figure` methods, | |
| to ensure consistency. Results can also be printed using the `present_results` and `present_all_results` methods. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.