def get_gin_confg_strs():
"""
Obtain both the operative and inoperative config strs from gin.
The operative configuration consists of all parameter values used by
configurable functions that are actually called during execution of the
current program, and inoperative configuration consists of all parameter
configured but not used by configurable functions. See `gin.operative_config_str()`
and `gin_utils.inoperative_config_str` for more detail on how the config is generated.
Returns:
md_operative_config_str (str): a markdown-formatted operative str
md_inoperative_config_str (str): a markdown-formatted inoperative str
"""
operative_config_str = gin.operative_config_str()
md_operative_config_str = _markdownify_gin_config_str(
operative_config_str,
'All parameter values used by configurable functions that are actually called'
)
md_inoperative_config_str = gin_utils.inoperative_config_str()
if md_inoperative_config_str:
md_inoperative_config_str = _markdownify_gin_config_str(
md_inoperative_config_str,
"All parameter values configured but not used by program. The configured "
"functions are either not called or called with explicit parameter values "
"overriding the config.")
return md_operative_config_str, md_inoperative_config_str
def summarize_gin_config():
"""Write the operative and inoperative gin config to Tensorboard summary.
The operative configuration consists of all parameter values used by
configurable functions that are actually called during execution of the
current program, and inoperative configuration consists of all parameter
configured but not used by configurable functions. See `gin.operative_config_str()`
and `gin_utils.inoperative_config_str` for more detail on how the config is generated.
"""
operative_config_str = gin.operative_config_str()
md_config_str = _markdownify_gin_config_str(
operative_config_str,
'All parameter values used by configurable functions that are actually called'
)
tf.summary.text('gin/operative_config', md_config_str)
inoperative_config_str = gin_utils.inoperative_config_str()
if inoperative_config_str:
md_config_str = _markdownify_gin_config_str(
inoperative_config_str,
"All parameter values configured but not used by program. The configured "
"functions are either not called or called with explicit parameter values "
"overriding the config.")
tf.summary.text('gin/inoperative_config', md_config_str)