Skip to content

Definition of supported representations by services and service docs fixes#934

Draft
thehrh wants to merge 10 commits into
masterfrom
stages_supported_reps_and_doc_format
Draft

Definition of supported representations by services and service docs fixes#934
thehrh wants to merge 10 commits into
masterfrom
stages_supported_reps_and_doc_format

Conversation

@thehrh
Copy link
Copy Markdown
Collaborator

@thehrh thehrh commented Apr 29, 2026

Key changes and fixes:

  • almost all services with restrictions on their data representations now explicitly declare which ones they support
    • mostly for cases in which services do not implement setup+compute or apply: None is entered as the only supported corresponding mode
      • note: we might consider enforcing this automatically at the (I think) Stage or Pipeline level, after detecting which of the three functions are not implemented—if any ("has setup", "has compute", "has apply")
    • odd case of data.simple_signal, where apply_mode=MultiDimBinning is assumed in setup_function, but
      apply_function sets rep. to "events" (hard-coded) -> currently declares support of MultiDimBinning
    • removed need for given service to specify each dict value as a list (e.g. None instead of [None])
  • removed instances of superfluous representation setting, when the Pipeline already takes care of that
  • a recently introduced dangerous bug is fixed that allowed running with a representation set to None even though the corresponding function is implemented (see new tests in core.pipeline module)
  • representation consistency is now validated separately in setup(), compute(), and apply() functions in case the Stage somehow became misconfigured (unlikely to have any significant performance impact on realistic pipelines IMO)

Documentation improvements:

  • fixed and standardised docstring formatting across all services (in particular parameter & notes—expected container keys—sections)
  • clean up "PISA Pi" mentions
  • updated copyright years

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant