Skip to content

Detect service implementation of compute+setup and apply, definitions of supported representations and service docs fixes#934

Draft
thehrh wants to merge 20 commits into
masterfrom
stages_supported_reps_and_doc_format
Draft

Detect service implementation of compute+setup and apply, definitions of supported representations and service docs fixes#934
thehrh wants to merge 20 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:

  • expose whether service overrides setup_function, compute_function, or apply_function via has_setup, has_compute, and has_apply function -> default deduction of allowed representations at Stage level
  • almost all services with restrictions on their data representations now explicitly declare which ones they support
    • 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

@thehrh thehrh changed the title Definition of supported representations by services and service docs fixes Detect service implementation of compute+setup and apply, definitions of supported representations and service docs fixes May 24, 2026
thehrh and others added 6 commits May 27, 2026 03:33
…nding function isn't implemented (for now, possibly change later) [no ci]
…d include md output in stage modes notebook for now (TODO: fix notebook) [no ci]
…tion_modes -> translation_modes; representation management unit test; update container module docs
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