Migrate defaults to a separate file #1356
Open
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
ishaileshpant
force-pushed
the
refactor_aggregator
branch
from
f4d7131 to
7258373
Compare
ishaileshpant
changed the title
ishaileshpant
force-pushed
the
refactor_aggregator
branch
from
7258373 to
57b8fa4
Compare
ishaileshpant
requested review from
MasterSkepticista,
kta-intel,
psfoley and
teoparvanov
as code owners
ishaileshpant
changed the title
There was a problem hiding this comment.
Thanks for picking this up @ishaileshpant.
Two suggestions:
- It is recommended to keep constants at a module-level.
- Can remove
DEFAULT_string for all constants. Upper case obviates the need to be explicit.
The only case that it won't address is some constants span across modules and hence i move to global package level else duplication of constants will be there agree on the "default" prefix, in fact we can even name the file as defaults, that would further simplify the names and purpose becomes explicit |
ishaileshpant
force-pushed
the
refactor_aggregator
branch
from
57b8fa4 to
db21d90
Compare
…d aggregator - Rebased 10.Feb.2 Signed-off-by: Shailesh Pant <[email protected]>
ishaileshpant
force-pushed
the
refactor_aggregator
branch
from
db21d90 to
667819b
Compare
MasterSkepticista
changed the title
There was a problem hiding this comment.
Would suggest renaming it to defaults.py.
Using defaults.ROUNDS_TO_TRAIN increases readability compared to constants.ROUNDS_TO_TRAIN in my opinion.
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.
This PR refactors the aggregator and collaborator modules by replacing hard-coded “magic” numbers and strings with centralized constant definitions. A new file, constants.py, has been introduced in the openfl/component directory to store these default values. This change improves maintainability and consistency across the codebase.
Motivation
Hard-coded values (e.g., 256, "tensor.db", "RESET", etc.) were scattered in the code. Extracting them into a constants file helps prevent errors and makes future updates easier.
Using descriptive constant names (like ROUNDS_TO_TRAIN and CERT_COMMON_NAME) clarifies the purpose of each value and allows for a single point of modification if defaults need to change.