Improve documentation for tuning.py #93
Closed
Conversation
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
flinder
requested review from
Lorenzo-Perini,
TaXxER and
danielha1
as code owners
meta-cla
bot
added
the
CLA Signed
flinder
force-pushed
the
export-D90260538
branch
from
f4629fc to
d3f819f
Compare
Summary:
Applied the following code quality fixes:
### `tuning.py`
1. **Wrapped long comment** (line 101) - Split the 121-char comment into two lines for readability
2. **Replaced `assert` with proper exception** (line 166) - Changed `assert df_val is not None` to `raise ValueError(...)` for proper runtime validation instead of debug assertions
3. **Converted string concatenation to f-string** (line 221) - Changed `"lightgbm_autotuning" + str(uuid.uuid4())[:8]` to `f"lightgbm_autotuning_{uuid.uuid4().hex[:8]}"`
### `test_tuning.py`
1. **Fixed PascalCase variable** - `BoTorch_count` → `botorch_count` (Google style: snake_case for variables)
2. **Converted `.format()` to f-strings** - Updated 3 assertion messages to use f-strings
3. **Fixed data slice bug** - Changed `sample_data.iloc[:80]` to `sample_data.iloc[:40]` (the fixture only has 50 samples, so `[:80]` was incorrectly returning all rows instead of an 80/20 split)
Reviewed By: TaXxER
Differential Revision: D90259815
Summary: * Add missing docstring to public data class `ParameterConfig` * Add :returns: documentation `tune_mcgrad_parameters` * Add minimal explanation to internal helper `_suppress_logger` Reviewed By: TaXxER Differential Revision: D90260538
flinder
force-pushed
the
export-D90260538
branch
from
d3f819f to
d40d9ad
Compare
|
This pull request has been merged in aed9f16. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary:
ParameterConfigtune_mcgrad_parameters_suppress_loggerDifferential Revision: D90260538