o ,wi+- @sHdZddlZddlZddlZddlmZmZmZmZm Z ddl m Z ddl m Z ddl mZddl mZejZe dZd ed eejd efd d Zd"d eded efddZd eded eejfddZe Zd ed efddZ d#ddd edeeedeeeeefd efddZGdddZ d$d eded efd d!ZdS)%a<Helper functions for visualization of Fiddle configurations. By default, you should be able to call APIs in `graphviz` and `printing` with no special handling. But some real-world configurations become gigantic, and so having a few helper functions for trimming them for interactive demos and such can be valuable. N)AnyDictListOptionalTypeVar)daglish)diffing)config)graphviz_custom_object_Tr trimreturncCst|dd|DS)aReturns a deep copy of a Buildable, with certain nodes replaced. This copy should have the same DAG structure as the original configuration. Example usage: graphviz.render(visualize.trimmed(config, [config.my_large_model_sub_config])) Args: config: Root buildable object, or collection of buildables. trim: List of sub-buildables that will be replaced by Trimmed() instances. Returns: Copy of the Buildable with nodes replaced. cSsi|]}t|tqS)idTrimmed).0 sub_configrr_/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/fiddle/_src/experimental/visualize.py :sztrimmed..)copydeepcopy)r r rrrtrimmed(srFremove_deep_defaultscs`idtjdtjffdd dtdtdtjdtfdd d tjffd d }tj||S) aTrims arguments that match their default values. Args: config: Root buildable object, or nested structure of Buildables. remove_deep_defaults: Whether to remove defaults that are equal to dataclass.field(default_factory=auto_config_fn) defaults. If any of these default values have external references, i.e. they are shared, then they will not be removed. Returns: Copy of the Buildable with args matching defaults removed. buildabler csBt|}t|t|f}|vr|St||}||<|SN) config_lib get_callabletyper)r fn_or_clskeyresult)cached_deep_defaultsrr _get_defaultPs  z+with_defaults_trimmed.._get_defaultnode attr_name parent_statecsfdd|jddDfdddtjdtffd d }tj||jj|jj|jjd }t|g|j t R||}|||S) auReturns whether we can safely delete a deep default. (This function presumes we've already checked equality with the default, and helps to check that sharing isn't altered.) Args: node: Default node to delete. attr_name: Attribute referring to `node`. parent_state: State from the traversal, which should correspond to `parent`. cs g|] }g|tRqSr)rAttr)r parent_path)r$rr iszJwith_defaults_trimmed..can_remove_deep_default..T allow_cachingcstfddDS)Nc3s$|] }dt||kVqdSr)len)r node_pathpathrr os  zewith_defaults_trimmed..can_remove_deep_default.._goes_through_node..)anyr-)valid_paths_to_noder-r_goes_through_nodens zRwith_defaults_trimmed..can_remove_deep_default.._goes_through_nodesubstater csB||r t|r dS|D] }|sdSqt||SNTF)is_traversabler is_immutable get_all_pathsallyield_map_child_values)valuer3sub_path)r2rr_helperts zGwith_defaults_trimmed..can_remove_deep_default.._helper) traversal_fnroot_objregistry paths_cache) r7rStateboolMemoizedTraversal traversalr>r?r@ current_pathr&)r#r$r%r< sub_traversalstater)r2r$r1rcan_remove_deep_defaultYs$     z6with_defaults_trimmed..can_remove_deep_defaultrGcst|tjrTi}r|j}d}t|jD];\}}|jj|d}|dur)q||vr1||n|j }|j t j j krS||krS|||rS|rNt|}d}t||q||Sr4) isinstancer Buildable __arguments__listitems__signature_info__ parametersgetdefaultkindinspect Parameter VAR_KEYWORDrdelattr map_children)r:rG deep_defaults should_copyname attr_valueparam param_default)r"rHrrr traverse_fns*      z*with_defaults_trimmed..traverse_fn) rrJrstrrrArBrCrun)r rr^r)r"r!rHrrwith_defaults_trimmed>s  4radepthcs^iidtjdtfdddtjddffdd }tj||fd d DS) aReturns a list of sub-Buildable objects over a given depth from the root. If a sub-Buildable has multiple paths from the root to it, its depth is the *minimum* distance of those paths. Furthermore, only Buildable nodes count towards the depth; if a sub-configuration is nested in containers like lists, tuples, or dicts, those do not count. This is because this function is primarily geared towards visualization, and those containers are usually displayed inline. Args: config: Root buildable object, or collection of buildable objects. depth: Depth value. Returns: List of all sub-Buildables with depth strictly greater than `depth`. r.r cSstdd|DS)Ncss$|] }t|tjr dndVqdS)rN)rIrr&)reltrrrr/s"z0depth_over.._path_len..)sumr-rrr _path_lenszdepth_over.._path_lenrGNcsZt|tjr!|jdd}tfdd|Dt|<|t|<|j|ddD]}q(dS)NTr)c3s|]}|VqdSrr)rr.)rfrrr/z/depth_over..traverse..) ignore_leaves)rIrrJr7minrr9)r#rG all_paths_)rf id_to_node node_to_depthrrtraverses   zdepth_over..traversecs g|] \}}|kr|qSrr)rr node_depth)rbrlrrr(s zdepth_over..)rPathintrArCr`rM)r rbrnr)rfrbrlrmr depth_overs rrcCsdtjfdd}tj||S)aCReturns a skeleton of a configuration. Args: config: Buildable item, or collection of Buildable items. Returns: Copy of `config` that has all of the original Buildable's, plus any fields and containers necessary to make all of those original Buildable's linked. Any leaf arguments (primitives, containers of primitives) are removed. In cases where there is a list with primitives and buildables, then the primitive will be replaced with AnyValue and the buildable will be maintained, like [1, fdl.Config(Foo)] --> [AnyValue, fdl.Config(Foo)]. rGcSs|||stSt|tjr)||}t|D] \}}|tur&t||q|S| |}t dd|j Dr<| StS)Ncss|]}|tuVqdSr) _any_value)ritemrrrr/rgz.structure..traverse..) r5rsrIrrJrWordered_argumentsrMrVflattened_map_childrenr0values unflatten)r:rGr rZ sub_valuerrrrns     zstructure..traverse)rrArCr`)r rnrrr structuresrz)fields_by_config_idtop_level_fieldsr{cs|rt|niD]\}}t|tstd|t|ttfs(tdq |dur>t|ttfs8td|t|<sEt|Sdt j ffdd }t j ||S)a1Trims fields to a list of desired fields. Args: config: Configuration object. top_level_fields: Fields on the top-level configuration object to keep. fields_by_config_id: Fields to keep, indexed by id(sub_config). Returns: Deep copy of configuration object, with defaults trimmed. z4fields_by_config_id should have integer keys, found z:Expected fields_by_config_id values to be lists or tuples.Nz0Expected top_level_fields to be a list or tuple.rGcsbt|tjr,t|vr,t|}t|}tt|t|D] }t||tq"| |Sr) rIrrJrrsetrusetattrrrW)r:rGto_keepargument fields_by_idrrrns    z trim_fields_to..traverse) rrMrIrq TypeErrorrLtuplerrrrArCr`)r r|r{rr:rnrrrtrim_fields_tos&   rc@s&eZdZdZdefddZddZdS)_TruncatedReprz>Represent the truncated fields for visualization purpose only.prefixcCs ||_dSr_prefix)selfrrrr__init__,s z_TruncatedRepr.__init__cCs|jSrr)rrrr__repr__/sz_TruncatedRepr.__repr__N)__name__ __module__ __qualname____doc__r_rrrrrrr)s r< thresholdcsDttr dkrtdddtjffdd }tj||S)zTrims fields to a bounded length. Args: config: Configuration object. threshold: Long fields will be trimmed to the threshold length. Returns: Deep copy of configuration object, with long fileds trimmed. rz&threshold must be a positive int, got .rGcst|tjr=tt|D]/}t||}t|tjtttfs.traverse)rIrq ValueErrorrrArCr`)r rrnrrrtrim_long_fields3sr)Fr)r) rrrSrtypingrrrrrfiddlerr fiddle._srcr rr rr rJrrBrarqrrAnyValuersrzr_rrrrrrrsJ    n*$  .