Skip to content

Commit 4dc4e7c

Browse files
Clarify broadcast docstring
1 parent c6506ef commit 4dc4e7c

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

shimmer/modules/losses.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -565,25 +565,23 @@ def broadcast(
565565
Computes broadcast demi-cycle (with fused) and translation losses, and prepares
566566
precomputed artifacts for cycle losses.
567567
568-
This return multiple metrics:
568+
This returns multiple metrics:
569569
* `demi_cycles`
570-
* `cycles`
571570
* `translations`
572571
* `from_{start_group}_to_{domain}_loss` where `{start_group}` is of the form
573572
"{domain1,domain2,domainN}" sorted in alphabetical order
574573
(e.g. "from_{t,v}_to_t_loss"). Note: fused cases are aggregated into
575574
`demi_cycles`.
576575
* `from_{start_group}_to_{domain}_{metric}` with additional metrics provided by
577-
the domain_mod's `compute_broadcast_loss` output
576+
the domain module's loss outputs
578577
* `from_{start_group}_through_{target_group}_to_{domain}_case_{case_group}_loss`
579578
where `{start_group}`, `{target_group}` and `{case_group}` is of the form
580579
"{domain1,domain2,domainN}" sorted in alphabetical order
581580
(e.g. "from_{t}_through_{v}_to_t_case_{t,v}_loss"). `{start_group}` represents the input
582581
domains, `{target_group}` the target domains used for the cycle and
583582
`{case_group}` all available domains participating to the loss.
584583
* `from_{start_group}_through_{target_group}_to_{domain}_case_{case_group}_{metric}`
585-
additional metrics provided by the domain_mod's `compute_broadcast_loss`
586-
output
584+
additional metrics provided by the domain module's loss outputs
587585
588586
Args:
589587
gw_mod (`shimmer.modules.gw_module.GWModuleBase`): The GWModule to use

0 commit comments

Comments
 (0)