refactor: rename neps.XParameter
to neps.X
#149
Merged
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 pull request introduces the update to
neps.XParameter
classes and replaces them with the newneps.X
classes, while maintaining backwards compatibility forneps.XParameter
usage. Deprecation warnings have been introduced forneps.XParameter
classes to inform the users of the changes and advise them to update their code accordingly.Renaming Parameter Classes:
README.md
,docs/index.md
,docs/getting_started.md
,docs/doc_yamls/architecture_search_space.py
: Updated parameter class names fromFloatParameter
,IntegerParameter
,CategoricalParameter
, andConstantParameter
toFloat
,Integer
,Categorical
, andConstant
, respectively. [1] [2] [3] [4]docs/reference/pipeline_space.md
: Reflected the new parameter class names in the documentation. [1] [2] [3]Source Code Updates:
neps/__init__.py
: Removed old parameter class aliases and added new ones to the import list.neps/api.py
,neps/optimizers/grid_search/optimizer.py
,neps/optimizers/multi_fidelity/ifbo.py
,neps/optimizers/multi_fidelity/successive_halving.py
,neps/optimizers/multi_fidelity_prior/utils.py
,neps/sampling/priors.py
: Updated references to the renamed parameter classes. [1] [2] [3] [4] [5] [6]Import Adjustments:
neps/search_spaces/__init__.py
: Adjusted imports to include the newly named parameter classes.These changes ensure consistency across the codebase and documentation, making the parameter class names more intuitive and easier to understand.