feat: add GCP Vertex.AI hyperparameter tuning handler#3762
Draft
Aanushka001 wants to merge 2 commits into
Draft
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
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.
Description
This PR adds a new event handler
VertexAILoggerthat enables PyTorch Ignite training code to report metrics to GCP Vertex AI's hyperparameter tuning service.Fixes #3023
What's included:
VertexAILogger- ABaseLoggersubclass that writes metrics in the format expected by Vertex AI's hyperparameter tuning service. It reads theCLOUD_ML_HP_METRIC_FILEenvironment variable (default:/tmp/hypertune/output.metrics) and writes newline-delimited JSON metric entries, following the same protocol as the officialcloudml-hypertunelibrary.OutputHandler- Helper handler to log engine output/metrics viareport_hyperparameter_tuning_metric().OptimizerParamsHandler- Helper handler to log optimizer parameters (e.g., learning rate).Usage example
How it works
Vertex AI hyperparameter tuning works by reading metric values from a file at the path specified by the
CLOUD_ML_HP_METRIC_FILEenvironment variable. This handler writes the metrics in the correct newline-delimited JSON format, allowing Vertex AI to evaluate trial performance. No external dependencies are required.Checklist
BaseLoggerpattern (likeWandBLogger,MLflowLogger)ignite/handlers/__init__.py