Skip to content

update signature for laplace bernoulli logit functions. - #3355

Open
charlesm93 wants to merge 2 commits into
developfrom
fix/3353-laplace_bernouilli_logit
Open

update signature for laplace bernoulli logit functions.#3355
charlesm93 wants to merge 2 commits into
developfrom
fix/3353-laplace_bernouilli_logit

Conversation

@charlesm93

Copy link
Copy Markdown
Member

Summary

Fixes #3353

Replaces the signatures for laplace_marginal_bernoulli_logit_lpmf and laplace_latent_bernoulli_logit_rng so that the user passes in a vector of observations and a vector of indices, indicating to which group each observation belongs to. This is consistent with what is the documentation and what was done for other laplace functions with a built-in likelihood.

Tests

Updates made to laplace_marginal_bernoulli_logit_lpmf_test.cpp and laplace_bernoulli_logit_rng_test.cpp so that the new signature gets tested.

Side Effects

The old signature expected users to pass in sufficient statistics, which led to some efficiency gain. However, the new code, while slower, has a more user-friendly interface.

Release notes

  • Fix signatures for laplace functions with built-in bernoulli_logit likelihood.

Checklist

  • Copyright holder: Charles Margossian and University of British Columbia

    The copyright holder is typically you or your assignee, such as a university or company. By submitting this pull request, the copyright holder is agreeing to the license the submitted work under the following licenses:
    - Code: BSD 3-clause (https://opensource.org/licenses/BSD-3-Clause)
    - Documentation: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/)

  • the basic tests are passing (ToDO: run all those...)

    • unit tests pass (to run, use: ./runTests.py test/unit)
    • header checks pass, (make test-headers)
    • dependencies checks pass, (make test-math-dependencies)
    • docs build, (make doxygen)
    • code passes the built in C++ standards checks (make cpplint)
  • the code is written in idiomatic C++ and changes are documented in the doxygen

  • the new changes are tested

@charlesm93
charlesm93 requested a review from SteveBronder August 4, 2026 01:59
@SteveBronder

Copy link
Copy Markdown
Collaborator

Make sure your parameters are documented


/home/jenkins/workspace/Stan_Math_PR-3355/stan/math/mix/prob/laplace_marginal_bernoulli_logit_lpmf.hpp:100: error: The following parameter of stan::math::laplace_marginal_bernoulli_logit_lpmf(const std::vector< int > &y, const std::vector< int > &n_samples, Mean &&mean, int hessian_block_size, CovarFun &&covariance_function, CovarArgs &&covar_args, std::ostream *msgs) is not documented:

  parameter 'n_samples'

/home/jenkins/workspace/Stan_Math_PR-3355/stan/math/mix/prob/laplace_marginal_bernoulli_logit_lpmf.hpp:100: error: The following parameter of stan::math::laplace_marginal_bernoulli_logit_lpmf(const std::vector< int > &y, const std::vector< int > &n_samples, Mean &&mean, int hessian_block_size, CovarFun &&covariance_function, CovarArgs &&covar_args, std::ostream *msgs) is not documented:

  parameter 'n_samples'

/home/jenkins/workspace/Stan_Math_PR-3355/stan/math/mix/prob/laplace_marginal_bernoulli_logit_lpmf.hpp:30: error: The following parameter of stan::math::bernoulli_logit_likelihood::operator()(const ThetaVec &theta, const YVec &y, const std::vector< int > &y_index, Mean &&mean, std::ostream *pstream) const is not documented:

  parameter 'pstream'

@SteveBronder

Copy link
Copy Markdown
Collaborator

Everything else here looks good! ping me when the tests pass after the docs fix and I'll approve

@SteveBronder

Copy link
Copy Markdown
Collaborator

fyi I think the failing tests here are just some github CI issue and not your changes. Going to wait a bit to restart them as I just tried and it failed to spinup the machines

@WardBrian

Copy link
Copy Markdown
Member

Yeah, not related to the changes: https://www.githubstatus.com/incidents/qcvjkzcs7j74

@stan-buildbot

Copy link
Copy Markdown
Contributor

Name Old Result New Result Ratio Performance change( 1 - new / old )
gp_regr/gp_regr.stan 0.11 0.26 0.44 -126.49% slower
gp_regr/gen_gp_data.stan 0.02 0.02 0.99 -0.95% slower
arK/arK.stan 1.66 1.62 1.03 2.65% faster
eight_schools/eight_schools.stan 0.06 0.06 1.02 2.02% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 8.92 8.75 1.02 1.81% faster
pkpd/one_comp_mm_elim_abs.stan 20.62 19.82 1.04 3.87% faster
pkpd/sim_one_comp_mm_elim_abs.stan 0.27 0.26 1.06 5.76% faster
sir/sir.stan 73.03 70.41 1.04 3.59% faster
gp_pois_regr/gp_pois_regr.stan 2.57 2.43 1.06 5.29% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan 3.0 2.89 1.04 3.69% faster
irt_2pl/irt_2pl.stan 5.56 5.18 1.07 6.78% faster
arma/arma.stan 0.33 0.31 1.07 6.72% faster
garch/garch.stan 0.49 0.48 1.04 3.48% faster
low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.01 0.93 -7.45% slower
performance.compilation 272.87 279.61 0.98 -2.47% slower
Mean result: 0.987895591136476

Jenkins Console Log
Blue Ocean
Commit hash: 1b7af702d0682010809bbb4cfea5279755f62c67


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: Split huge pages
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
Vulnerability Vmscape: Mitigation; IBPB before exit to userspace
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

@WardBrian

Copy link
Copy Markdown
Member

@SteveBronder tests have passed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

laplace_marginal: inconsistency between doc and math for built-in bernoulli_logit likelihood

4 participants