ray.train.context.TrainContext.get_metadata#

TrainContext.get_metadata() → Dict[str, Any][source]#

User metadata dict passed to the Trainer constructor.

PublicAPI (beta): This API is in beta and may change before becoming stable.

Warning

DEPRECATED: This API is deprecated and may be removed in future Ray releases. get_metadata was an experimental API that accessed the metadata passed to <Framework>Trainer(metadata=...). This API can be replaced by passing the metadata directly to the training function (e.g., via train_loop_config). See this issue for more context and migration options: ray-project/ray#49454. Disable these warnings by setting the environment variable: RAY_TRAIN_ENABLE_V2_MIGRATION_WARNINGS=0