Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance flexibility of 'run_args' to allow mixed usage of direct and YAML-based arguments #67

Open
danrgll opened this issue Apr 25, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@danrgll
Copy link
Collaborator

danrgll commented Apr 25, 2024

Currently, you can either define all arguments via the YAML setting 'run_args' or by providing the arguments directly to NePS.

A mixed approach would suit best. This would enable flexible usage, for example, if you don't want to provide run_pipeline via the YAML and instead want to provide it directly to neps.run(). It also might be beneficial for quick changes, as you would not have to look up the YAML again.

Problem: When quick changes are made to optional parameters that have a default value, it is unclear whether the default value was provided by the user or set by the function itself.

See example:
neps.run(run_args="config.yaml", post_summary=False)

run_args: post_summary: True

Proposed Solution: Enable mixed usage solely for required parameters to prevent issues related to default values in optional parameters. Additionally, consider ignoring double references by introducing a hierarchy where 'run_args' takes precedence.

Alternative Solution: Construct a wrapper around neps.run. However, this approach would result in users losing access to the function descriptions of neps.run, which could impact usability.

See #61

@danrgll danrgll self-assigned this Apr 25, 2024
@danrgll danrgll mentioned this issue Apr 25, 2024
12 tasks
@danrgll danrgll added the enhancement New feature or request label Apr 25, 2024
@eddiebergman eddiebergman added this to the Declaritive milestone May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants