Skip to content

Addition of custom parameter generation when running studies.#129

Merged
FrankD412 merged 12 commits intodevelopfrom
feature/custom_parameterization
Aug 8, 2018
Merged

Addition of custom parameter generation when running studies.#129
FrankD412 merged 12 commits intodevelopfrom
feature/custom_parameterization

Conversation

@FrankD412
Copy link
Copy Markdown
Member

This PR adds the ability for a user to use custom code for generating parameters. In all cases, metadata about parameters is now dumped. In order to use this feature, a user simply uses the command line maestro run --pgen <path to .py> <path to study YAML>. Within the file specified by the --pgen flag, the function get_custom_generator() must be defined and must return a ParameterGenerator instance.

@FrankD412 FrankD412 self-assigned this Aug 6, 2018
@FrankD412
Copy link
Copy Markdown
Member Author

@jsemler -- Would you mind looking at the metadata generated? I went with what I thought was reasonable, but if you could provide any insight into what might be useful please let me know.

@FrankD412 FrankD412 requested a review from jsemler August 6, 2018 21:30
@FrankD412 FrankD412 force-pushed the feature/custom_parameterization branch from e447053 to bade17a Compare August 7, 2018 00:02
Copy link
Copy Markdown
Collaborator

@jsemler jsemler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I think the parameters.yaml is reasonable. I didn’t see the -pgen input in the metadata anywhere. Should that be written to either metadata.yaml or parameters.yaml?

@FrankD412
Copy link
Copy Markdown
Member Author

That's actually a good thought -- I hadn't thought to document the path. Actually, I was also considering copying the code file itself into the directory but wasn't sure if that was overkill.

@jsemler
Copy link
Copy Markdown
Collaborator

jsemler commented Aug 8, 2018

Having the path to the -pgen file in the metadata would be useful. I think copying the code file could potentially be helpful for both archiving and reproducibility. I will have to think on that more.

@FrankD412
Copy link
Copy Markdown
Member Author

@jsemler -- I've made the requested changes, can you give it another pass?

Copy link
Copy Markdown
Collaborator

@jsemler jsemler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@FrankD412 -- I've tested the new update and the code file copies over as expected.

@FrankD412 FrankD412 merged commit b72bacb into develop Aug 8, 2018
@FrankD412 FrankD412 deleted the feature/custom_parameterization branch August 8, 2018 19:26
FrankD412 added a commit that referenced this pull request Sep 30, 2018
* Update setup.py to 1.1.3dev

* Updated the getting started documentation

* Added examples for running both lulesh specs

* Flux for Spectrum bugfixes (#116)

* Additional arguments can be passed through batch.

* Correction of the use of extend to append.

* Removal of OMPI vars from env.

* Reversal of env altering.

* Addition of mpi exe to batch.

* Removal of -gpu flag

* Addition of "allocated" to PENDING set.

* Correction of the check_status method call.

* Correction of the Flux import

* Addition of the EnvironmentError to try/catch for check_status.

* Addition of jobid to submission INFO logging.

* Workflow setup fix (#117)

* Fixed a workflow setup issue caused by spaces in the spec name

* Additional dirname formatting

* Refactor of the Study class to breakdown complex APIs (#118)

* Minor docstring correction.

* Change to study setup API to break out workspace creation.

* Update Maestro frontend to use new Study method.

* Renamed Study.setup to be better communicate its functionality.

* Correction to style for configure_study method.

* Moved environment application to add_step.

* Split out acquiring environment elements to its own method.

* Updates to staging checks.

* Renamed _setup_linear and _setup_parameterized from setup to stage for clarity.

* Tweaks and addition of starting to SpectrumFluxAdapter. (#119)

* Updated the LULESH examples to use the LULESH git repository for cloning the repo (#121)

* Add the generation of metadata to Study construction. (#120)

* Addition of method and tweaks to support metadata.

* Addition of call to the method for generating metadata.

* Correction to encode YAML string for py3 compatibility.

* Another attempt at py2-py3 compatible encoding.

* Addition of load_metadata method.

* Additional debug logging for the Flux Spectrum Adapter (#122)

* Additional logging for debugging of the adapter.

* Additional logging.

* Updated Exception.message references to Exception.args (#125)

* Fix status.csv 'State' column writeout. (#127)

* #107 Enhance/return codes (#128)

* #107 Added StudyStatus enumeration
Changed DAG execute_ready_steps to return StudyStatus enum instead of a boolean
conductor and maestro also accept StudyStatus and convert to return value

* #128 fixed issues found in pull request

* #107 added inline comments per PC

* #107 pulling out _check_study_completion
to avoid initial implementaion copy and paste error

* #107 fixed line length issue

* Bugfix that would cause the ExecutionGraph to not update when cancelled. (#131)

* Addition of custom parameter generation when running studies. (#129)

* Command line parameter for custom ParameterGenerators.

* Addition of sample custom parameter generation.

* Correction to missing parameters in SIZE.

* Addition of utility method for importing custom gen py files.

* Correction of syntax.

* Conversion of DOS newlines to Unix.

* Addition of call to check for custom code.

* Correction of a bad docstring.

* Addition of parameter metadata to Maestro.

* Addition of parameters to study metadata.

* Addition of copying of the parameter file to study workspace.

* Correction to a bug for attempting a restart when a restart isn't specified. (#133)

* Initial fix for steps that cannot restart.

* Comments to clarify logic.

* More flexible ExecutionGraph description API and logging of description. (#137)

* Tweaks to how the ExecutionGraph adds descriptions. Added logging.

* Updated study to use the new API and some minor refactor.

* Fixed #134

* Fix to Variable verification. (#138)

 Fixes #123

* Updates to Maestro documentation (#114)

* Updates to the README.

* Added initial getting started example documentation

* Addition of Quick Start documentation. (#130)

* Addition of Quick Start.

* Addition of cancellation status example.

* Corrections to quick start and fix for build errors.

* Addition of a LULESH study specification with heavier comments. (#132)

* Start of a LULESH spec that's commented.

* Addition of explanation of step structure.

* Additional comments about steps and dependencies.

* Minor tweaks to comments.

* Addition of parameter block comments.

* Addition of reference to launcher_token YAML

* Tweaks and edits based on feedback.

* Throttled workflows push steps into the ready queue multiple times. (#136)

* Moved 'mark_submitted' into ExecutionGraph 'execute'

* Conversion of ready_steps deque to use step names.

* Capping the available slots to the length of ready_steps.

* Fixes Popen output to use universal newlines. (#143)

* Addition of a shell util to centralize process creation settings.

* Switch to start_process method.

* Addition of docstring for start_process.

* Update to fix universal newline from false to true.

* Addition of a check for a list and a hard set of shell to False.

* Made conductor launch command a string.

* Fix behavior of start_process for localscriptadapter.

The shell=False flag was not being passed, nor were the env or cwd
arguments being used in the actual function.

* Clean up of start_process

* Cleans up GitDependency errors to not rely on return codes. (#144)

* Addition of a ping method.

* Tweaks to error logging.

* Moved specific existence exception out of return code check.

* Cleanup of some merge characters.

* Tweak for connectivity checking.

* Addition of info to the error message.

* Removal of git return codes since they don't mean anything.

* Update version number to 1.1.3.
FrankD412 added a commit that referenced this pull request Sep 23, 2019
* Command line parameter for custom ParameterGenerators.

* Addition of sample custom parameter generation.

* Correction to missing parameters in SIZE.

* Addition of utility method for importing custom gen py files.

* Correction of syntax.

* Conversion of DOS newlines to Unix.

* Addition of call to check for custom code.

* Correction of a bad docstring.

* Addition of parameter metadata to Maestro.

* Addition of parameters to study metadata.

* Addition of copying of the parameter file to study workspace.
FrankD412 added a commit that referenced this pull request Jan 22, 2020
* Command line parameter for custom ParameterGenerators.

* Addition of sample custom parameter generation.

* Correction to missing parameters in SIZE.

* Addition of utility method for importing custom gen py files.

* Correction of syntax.

* Conversion of DOS newlines to Unix.

* Addition of call to check for custom code.

* Correction of a bad docstring.

* Addition of parameter metadata to Maestro.

* Addition of parameters to study metadata.

* Addition of copying of the parameter file to study workspace.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants