@@ -595,7 +595,9 @@ def check_logcdf(
595
595
596
596
The following tests are performed by default:
597
597
1. Test PyMC3 logcdf and equivalent scipy logcdf methods give similar
598
- results for valid values and parameters within the supported edges.
598
+ results for valid values and parameters inside the supported edges.
599
+ Edges are excluded by default, but can be artificially included by
600
+ creating a domain with repeated values (e.g., `Domain([0, 0, .5, 1, 1]`)
599
601
Can be skipped via skip_paramdomain_inside_edge_test
600
602
2. Test PyMC3 logcdf method returns -inf for invalid parameter values
601
603
outside the supported edges. Can be skipped via skip_paramdomain_outside_edge_test
@@ -609,24 +611,24 @@ def check_logcdf(
609
611
pymc3_dist: PyMC3 distribution
610
612
domain : Domain
611
613
Supported domain of distribution values
612
- paramdomains : Dictionary of Pamameter : Domain pairs
614
+ paramdomains : Dictionary of Parameter : Domain pairs
613
615
Supported domains of distribution parameters
614
616
scipy_logcdf : Scipy logcdf method
615
617
Scipy logcdf method of equivalent pymc3_dist distribution
616
618
decimal : Int
617
- Level of precision with which pymc3_dist and scipy_logcdf are
618
- compared. Defaults to 6 for float64 and 3 for float32
619
+ Level of precision with which pymc3_dist and scipy_logcdf are compared.
620
+ Defaults to 6 for float64 and 3 for float32
619
621
n_samples : Int
620
622
Upper limit on the number of valid domain and value combinations that
621
- are compared between pymc3 and scipy methods. If n_samples is below
622
- the total number of combinations, a random subset is evaluated.
623
+ are compared between pymc3 and scipy methods. If n_samples is below the
624
+ total number of combinations, a random subset is evaluated.
623
625
Defaults to 100
624
626
skip_paramdomain_inside_edge_test : Bool
625
- Whether to compare pymc3 and scipy distributions match for valid values
626
- and parameters within the respective domain edges (excluding edges)
627
+ Whether to run test 1., which checks that pymc3 and scipy distributions
628
+ match for valid values and parameters inside the respective domain edges
627
629
skip_paramdomain_outside_edge_test : Bool
628
- Whether to test pymc3 distribution logcdf returns -inf for invalid
629
- parameter values that lie beyond the supported edge (excluding edges)
630
+ Whether to run test 2., which checks that pymc3 distribution logcdf
631
+ returns -inf for invalid parameter values outside the supported domain edge
630
632
631
633
Returns
632
634
-------
0 commit comments