Documentation #17
Open
Documentation #17
Conversation
This file contains 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
se-jaeger
approved these changes
Feb 14, 2025
| @@ -43,10 +69,10 @@ def _sample(self: EAR, data: pd.DataFrame, column: str | int, error_rate: float, | |||
| raise ValueError(msg) | |||
|
|
|||
| # we offset the upper bound of the lower_error_index by a) the existing number of errors in the row, and b) the number of errors to-be generated. | |||
| upper_bound = len(se_data) - sum(se_mask) - n_errors | |||
| upper_bound = len(se_data) - sum(se_mask) - n_errors # upper bound = length of data - current number of errors - number of errors to be generated | |||
There was a problem hiding this comment.
Suggested change
| upper_bound = len(se_data) - sum(se_mask) - n_errors # upper bound = length of data - current number of errors - number of errors to be generated | |
| upper_bound = len(se_data) - sum(se_mask) - n_errors |
There was a problem hiding this comment.
I think it's fine without this comment. Maybe thinking about renaming se_...
| lower_error_index = self._random_generator.integers(0, upper_bound) if upper_bound > 0 else 0 | ||
| error_index_range = range(lower_error_index, lower_error_index + n_errors) | ||
| selected_rows = data_column_error_free.sort_values(by=condition_to_column).iloc[error_index_range, :] | ||
| selected_rows = data_column_error_free.sort_values(by=condition_to_column).iloc[error_index_range, :] # Sort by the condition_to_column values |
There was a problem hiding this comment.
Suggested change
| selected_rows = data_column_error_free.sort_values(by=condition_to_column).iloc[error_index_range, :] # Sort by the condition_to_column values | |
| selected_rows = data_column_error_free.sort_values(by=condition_to_column).iloc[error_index_range, :] |
There was a problem hiding this comment.
I think it's fine without this comment. Maybe thinking about renaming se_...
| error_index_range = range(lower_error_index, lower_error_index + n_errors) | ||
| selected_rows = se_data_error_free.sort_values().iloc[error_index_range] | ||
| selected_rows = se_data_error_free.sort_values().iloc[error_index_range] # Introduce errors to locations of sorted values |
There was a problem hiding this comment.
Suggested change
| selected_rows = se_data_error_free.sort_values().iloc[error_index_range] # Introduce errors to locations of sorted values | |
| selected_rows = se_data_error_free.sort_values().iloc[error_index_range] |
I think that's clear enough without this comment.
Comment on lines
+49
to
+53
|
|
||
| Description: | ||
| Does error checking for the abstract method '_sample'. | ||
| Assigns the _random_generator attribute. | ||
| Calls subclass _sample method. |
There was a problem hiding this comment.
Suggested change
| Description: | |
| Does error checking for the abstract method '_sample'. | |
| Assigns the _random_generator attribute. | |
| Calls subclass _sample method. |
I feel that's not necessary for users.
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.
Added docstrings to many functions (some were private and simple enough to not seem to need one).