Skip to content

Add dispatcher class to manage stan::callbacks writer objects#3337

Closed
mitzimorris wants to merge 19 commits intodevelopfrom
feature/callbacks-dispatcher
Closed

Add dispatcher class to manage stan::callbacks writer objects#3337
mitzimorris wants to merge 19 commits intodevelopfrom
feature/callbacks-dispatcher

Conversation

@mitzimorris
Copy link
Member

@mitzimorris mitzimorris commented Mar 8, 2025

Submission Checklist

  • Run unit tests: ./runTests.py src/test/unit
  • Run cpplint: make cpplint
  • Declare copyright holder and open-source license: see below

Summary

Adds a new class dispatcher to stan::callbacks, used to map classes of outputs to an associated callbacks writer.
Implementation of design doc https://github.com/stan-dev/design-docs/blob/master/designs/0032-stan-output-formats.md.

  • Enum info_types used to classify outputs
  • Dispatcher maps types to callbacks
  • Public APIs in stan::services has single dispatcher arg, instead of one or more callback writer args.

Intended Effect

Simplify stan::services API calls and make it possible to add new output formats and types of outputs going forward.

How to Verify

Unit tests

Side Effects

N/A

Documentation

N/A

Copyright and Licensing

Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company): Columbia University

By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses:

@stan-buildbot
Copy link
Contributor

stan-buildbot commented Mar 8, 2025

Name Old Result New Result Ratio Performance change( 1 - new / old )
arma/arma.stan 0.32 0.32 0.99 -1.15% slower
low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.01 0.97 -2.59% slower
gp_regr/gen_gp_data.stan 0.03 0.02 1.06 5.58% faster
gp_regr/gp_regr.stan 0.1 0.09 1.03 3.2% faster
sir/sir.stan 69.09 70.7 0.98 -2.33% slower
irt_2pl/irt_2pl.stan 4.07 4.25 0.96 -4.43% slower
eight_schools/eight_schools.stan 0.06 0.05 1.06 5.57% faster
pkpd/sim_one_comp_mm_elim_abs.stan 0.25 0.24 1.05 4.43% faster
pkpd/one_comp_mm_elim_abs.stan 19.06 18.24 1.04 4.26% faster
garch/garch.stan 0.42 0.4 1.04 3.92% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan 2.66 2.58 1.03 2.98% faster
arK/arK.stan 1.79 1.73 1.04 3.59% faster
gp_pois_regr/gp_pois_regr.stan 2.85 2.7 1.05 5.1% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 8.68 8.34 1.04 3.95% faster
performance.compilation 181.89 189.4 0.96 -4.13% slower
Mean result: 1.0202819481125036

Jenkins Console Log
Blue Ocean
Commit hash: 342ab5a553631589b7bf9c47499fe6b237fc237c

Machine information No LSB modules are available. Distributor ID: Ubuntu Description: Ubuntu 20.04.3 LTS Release: 20.04 Codename: focal

CPU:
Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Byte Order: Little Endian
Address sizes: 46 bits physical, 48 bits virtual
CPU(s): 80
On-line CPU(s) list: 0-79
Thread(s) per core: 2
Core(s) per socket: 20
Socket(s): 2
NUMA node(s): 2
Vendor ID: GenuineIntel
CPU family: 6
Model: 85
Model name: Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz
Stepping: 4
CPU MHz: 2400.000
CPU max MHz: 3700.0000
CPU min MHz: 1000.0000
BogoMIPS: 4800.00
Virtualization: VT-x
L1d cache: 1.3 MiB
L1i cache: 1.3 MiB
L2 cache: 40 MiB
L3 cache: 55 MiB
NUMA node0 CPU(s): 0,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54,56,58,60,62,64,66,68,70,72,74,76,78
NUMA node1 CPU(s): 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59,61,63,65,67,69,71,73,75,77,79
Vulnerability Gather data sampling: Mitigation; Microcode
Vulnerability Itlb multihit: KVM: Mitigation: VMX disabled
Vulnerability L1tf: Mitigation; PTE Inversion; VMX conditional cache flushes, SMT vulnerable
Vulnerability Mds: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Meltdown: Mitigation; PTI
Vulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Reg file data sampling: Not affected
Vulnerability Retbleed: Mitigation; IBRS
Vulnerability Spec rstack overflow: Not affected
Vulnerability Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl
Vulnerability Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2: Mitigation; IBRS; IBPB conditional; STIBP conditional; RSB filling; PBRSB-eIBRS Not affected; BHI Not affected
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; Clear CPU buffers; SMT vulnerable
Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 invpcid_single pti intel_ppin ssbd mba ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts hwp hwp_act_window hwp_epp hwp_pkg_req pku ospke md_clear flush_l1d arch_capabilities

G++:
g++ (Ubuntu 9.4.0-1ubuntu1~20.04) 9.4.0
Copyright (C) 2019 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Clang:
clang version 10.0.0-4ubuntu1
Target: x86_64-pc-linux-gnu
Thread model: posix
InstalledDir: /usr/bin

@stan-buildbot
Copy link
Contributor

stan-buildbot commented Mar 9, 2025

Name Old Result New Result Ratio Performance change( 1 - new / old )
arma/arma.stan 0.34 0.32 1.07 6.17% faster
low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.01 0.97 -2.9% slower
gp_regr/gen_gp_data.stan 0.02 0.02 1.02 1.48% faster
gp_regr/gp_regr.stan 0.09 0.1 0.96 -4.02% slower
sir/sir.stan 70.08 69.91 1.0 0.24% faster
irt_2pl/irt_2pl.stan 4.25 4.03 1.05 5.08% faster
eight_schools/eight_schools.stan 0.05 0.05 1.0 -0.32% slower
pkpd/sim_one_comp_mm_elim_abs.stan 0.25 0.25 1.02 1.95% faster
pkpd/one_comp_mm_elim_abs.stan 19.18 18.88 1.02 1.61% faster
garch/garch.stan 0.43 0.4 1.06 5.56% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan 2.71 2.63 1.03 3.08% faster
arK/arK.stan 1.78 1.72 1.04 3.43% faster
gp_pois_regr/gp_pois_regr.stan 2.85 2.72 1.05 4.75% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 8.78 8.37 1.05 4.64% faster
performance.compilation 185.66 188.49 0.98 -1.52% slower
Mean result: 1.0208351473927182

Jenkins Console Log
Blue Ocean
Commit hash: 342ab5a553631589b7bf9c47499fe6b237fc237c

Machine information No LSB modules are available. Distributor ID: Ubuntu Description: Ubuntu 20.04.3 LTS Release: 20.04 Codename: focal

CPU:
Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Byte Order: Little Endian
Address sizes: 46 bits physical, 48 bits virtual
CPU(s): 80
On-line CPU(s) list: 0-79
Thread(s) per core: 2
Core(s) per socket: 20
Socket(s): 2
NUMA node(s): 2
Vendor ID: GenuineIntel
CPU family: 6
Model: 85
Model name: Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz
Stepping: 4
CPU MHz: 2400.000
CPU max MHz: 3700.0000
CPU min MHz: 1000.0000
BogoMIPS: 4800.00
Virtualization: VT-x
L1d cache: 1.3 MiB
L1i cache: 1.3 MiB
L2 cache: 40 MiB
L3 cache: 55 MiB
NUMA node0 CPU(s): 0,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54,56,58,60,62,64,66,68,70,72,74,76,78
NUMA node1 CPU(s): 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59,61,63,65,67,69,71,73,75,77,79
Vulnerability Gather data sampling: Mitigation; Microcode
Vulnerability Itlb multihit: KVM: Mitigation: VMX disabled
Vulnerability L1tf: Mitigation; PTE Inversion; VMX conditional cache flushes, SMT vulnerable
Vulnerability Mds: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Meltdown: Mitigation; PTI
Vulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Reg file data sampling: Not affected
Vulnerability Retbleed: Mitigation; IBRS
Vulnerability Spec rstack overflow: Not affected
Vulnerability Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl
Vulnerability Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2: Mitigation; IBRS; IBPB conditional; STIBP conditional; RSB filling; PBRSB-eIBRS Not affected; BHI Not affected
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; Clear CPU buffers; SMT vulnerable
Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 invpcid_single pti intel_ppin ssbd mba ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts hwp hwp_act_window hwp_epp hwp_pkg_req pku ospke md_clear flush_l1d arch_capabilities

G++:
g++ (Ubuntu 9.4.0-1ubuntu1~20.04) 9.4.0
Copyright (C) 2019 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Clang:
clang version 10.0.0-4ubuntu1
Target: x86_64-pc-linux-gnu
Thread model: posix
InstalledDir: /usr/bin

@mitzimorris
Copy link
Member Author

mitzimorris commented Mar 11, 2025

@WardBrian and @SteveBronder - this is a WIP

  • added classes callbacks::dispatcher and services::util::configure_dispatcher, with corresponding unit tests
  • as proof-of-concept, threaded dispatcher class through all of the Stan services::util functions (plus mcmc::hmc::base_hmc to get the stepsize and metric) and through services::sample::nuts_hmc_adapt_diag_e.

I would suggest simply adding the dispatcher, configure_dispatcher classes in their own PR, then taking the next step of refactoring the services layer API. discuss?

@stan-buildbot
Copy link
Contributor

stan-buildbot commented Mar 11, 2025

Name Old Result New Result Ratio Performance change( 1 - new / old )
arma/arma.stan 0.35 0.34 1.03 2.98% faster
low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.01 1.06 5.93% faster
gp_regr/gen_gp_data.stan 0.03 0.03 1.14 12.37% faster
gp_regr/gp_regr.stan 0.1 0.1 1.0 -0.2% slower
sir/sir.stan 72.34 72.75 0.99 -0.57% slower
irt_2pl/irt_2pl.stan 4.59 4.47 1.03 2.66% faster
eight_schools/eight_schools.stan 0.06 0.06 1.03 3.03% faster
pkpd/sim_one_comp_mm_elim_abs.stan 0.27 0.26 1.03 3.0% faster
pkpd/one_comp_mm_elim_abs.stan 21.58 20.04 1.08 7.11% faster
garch/garch.stan 0.45 0.46 0.99 -1.32% slower
low_dim_gauss_mix/low_dim_gauss_mix.stan 2.98 2.83 1.05 4.8% faster
arK/arK.stan 2.44 1.85 1.32 24.16% faster
gp_pois_regr/gp_pois_regr.stan 3.0 2.91 1.03 3.05% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 9.11 8.98 1.01 1.42% faster
performance.compilation 199.89 196.55 1.02 1.67% faster
Mean result: 1.0541277934373283

Jenkins Console Log
Blue Ocean
Commit hash: dfc21285f1149f6ea7bcc073ecbf5129975375f2

Machine information No LSB modules are available. Distributor ID: Ubuntu Description: Ubuntu 20.04.3 LTS Release: 20.04 Codename: focal

CPU:
Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Byte Order: Little Endian
Address sizes: 46 bits physical, 48 bits virtual
CPU(s): 80
On-line CPU(s) list: 0-79
Thread(s) per core: 2
Core(s) per socket: 20
Socket(s): 2
NUMA node(s): 2
Vendor ID: GenuineIntel
CPU family: 6
Model: 85
Model name: Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz
Stepping: 4
CPU MHz: 2400.000
CPU max MHz: 3700.0000
CPU min MHz: 1000.0000
BogoMIPS: 4800.00
Virtualization: VT-x
L1d cache: 1.3 MiB
L1i cache: 1.3 MiB
L2 cache: 40 MiB
L3 cache: 55 MiB
NUMA node0 CPU(s): 0,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54,56,58,60,62,64,66,68,70,72,74,76,78
NUMA node1 CPU(s): 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59,61,63,65,67,69,71,73,75,77,79
Vulnerability Gather data sampling: Mitigation; Microcode
Vulnerability Itlb multihit: KVM: Mitigation: VMX disabled
Vulnerability L1tf: Mitigation; PTE Inversion; VMX conditional cache flushes, SMT vulnerable
Vulnerability Mds: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Meltdown: Mitigation; PTI
Vulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Reg file data sampling: Not affected
Vulnerability Retbleed: Mitigation; IBRS
Vulnerability Spec rstack overflow: Not affected
Vulnerability Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl
Vulnerability Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2: Mitigation; IBRS; IBPB conditional; STIBP conditional; RSB filling; PBRSB-eIBRS Not affected; BHI Not affected
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; Clear CPU buffers; SMT vulnerable
Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 invpcid_single pti intel_ppin ssbd mba ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts hwp hwp_act_window hwp_epp hwp_pkg_req pku ospke md_clear flush_l1d arch_capabilities

G++:
g++ (Ubuntu 9.4.0-1ubuntu1~20.04) 9.4.0
Copyright (C) 2019 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Clang:
clang version 10.0.0-4ubuntu1
Target: x86_64-pc-linux-gnu
Thread model: posix
InstalledDir: /usr/bin

@mitzimorris
Copy link
Member Author

mitzimorris commented Mar 11, 2025

closing this, will submit PR for dispatcher and utility in a new PR.

@mitzimorris mitzimorris mentioned this pull request Mar 11, 2025
Closed
3 tasks
@mitzimorris mitzimorris deleted the feature/callbacks-dispatcher branch March 15, 2025 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mitzimorris @stan-buildbot