Skip to content

Update docstrings for changes in DimensionalData show methods #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 25, 2025
Merged

Update docstrings for changes in DimensionalData show methods #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4563c84
Update docstrings
sethaxen Jul 25, 2025
b22f57d
Increment patch number
sethaxen Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "InferenceObjects"
uuid = "b5cf5a8d-e756-4ee3-b014-01d49d192c00"
authors = ["Seth Axen <[email protected]> and contributors"]
version = "0.4.11"
version = "0.4.12"

[deps]
ANSIColoredPrinters = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
Expand Down
12 changes: 6 additions & 6 deletions ext/InferenceObjectsPosteriorStatsExt/loo_pit.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ julia> loo_result = loo(idata; var_name=:obs);

julia> loo_pit(idata, loo_result.psis_result.log_weights; y_name=:obs)
┌ 8-element DimArray{Float64, 1} loo_pit_obs ┐
├────────────────────────────────────────────┴─────────────────────────── dims ┐
↓ school Categorical{String} [Choate, Deerfield, …, St. Paul's, Mt. Hermon] Unordered
└──────────────────────────────────────────────────────────────────────────────┘
├────────────────────────────────────────────┴─────────────────── dims ┐
↓ school Categorical{String} ["Choate", …, "Mt. Hermon"] Unordered
└──────────────────────────────────────────────────────────────────────┘
"Choate" 0.942759
"Deerfield" 0.641057
"Phillips Andover" 0.32729
Expand Down Expand Up @@ -86,9 +86,9 @@ julia> idata = load_example_data("centered_eight");

julia> loo_pit(idata; y_name=:obs)
┌ 8-element DimArray{Float64, 1} loo_pit_obs ┐
├────────────────────────────────────────────┴─────────────────────────── dims ┐
↓ school Categorical{String} [Choate, Deerfield, …, St. Paul's, Mt. Hermon] Unordered
└──────────────────────────────────────────────────────────────────────────────┘
├────────────────────────────────────────────┴─────────────────── dims ┐
↓ school Categorical{String} ["Choate", …, "Mt. Hermon"] Unordered
└──────────────────────────────────────────────────────────────────────┘
"Choate" 0.942759
"Deerfield" 0.641057
"Phillips Andover" 0.32729
Expand Down
36 changes: 18 additions & 18 deletions src/inference_data.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,15 +311,15 @@ InferenceData with groups:
julia> idata_cat1.posterior
┌ 100×8×3 Dataset ┐
├─────────────────┴──────────────────────────────────── dims ┐
↓ draw ,
↓ draw,
→ chain,
↗ a_dim Categorical{String} ["x", "y", "z"] ForwardOrdered
↗ a_dim Categorical{String} ["x", …, "z"] ForwardOrdered
├──────────────────────────────────────────────────── layers ┤
:a eltype: Float64 dims: draw, chain, a_dim size: 100×8×3
:b eltype: Float64 dims: draw, chain size: 100×8
├────────────────────────────────────────────────── metadata ┤
Dict{String, Any} with 1 entry:
"created_at" => "2025-02-04T10:49:16.704"
"created_at" => "2025-07-25T10:11:18.92"
```

Alternatively, we can concatenate along a new `run` dimension, which will be created.
Expand All @@ -331,17 +331,17 @@ InferenceData with groups:

julia> idata_cat2.posterior
┌ 100×4×3×2 Dataset ┐
├───────────────────┴─────────────────────────────────── dims ┐
↓ draw ,
├───────────────────┴───────────────────────────────────────── dims ┐
↓ draw,
→ chain,
↗ a_dim Categorical{String} ["x", "y", "z"] ForwardOrdered,
↗ a_dim Categorical{String} ["x", …, "z"] ForwardOrdered,
⬔ run
├─────────────────────────────────────────────────────────────┴ layers ┐
├─────────────────────────────────────────────────────────── layers ┤
:a eltype: Float64 dims: draw, chain, a_dim, run size: 100×4×3×2
:b eltype: Float64 dims: draw, chain, run size: 100×4×2
├──────────────────────────────────────────────────────────── metadata ┤
├───────────────────────────────────────────────────────── metadata ┤
Dict{String, Any} with 1 entry:
"created_at" => "2025-02-04T10:49:16.704"
"created_at" => "2025-07-25T10:11:18.92"
```

We can also concatenate only a subset of groups and merge the rest, which is useful when
Expand All @@ -363,27 +363,27 @@ InferenceData with groups:

julia> idata_cat3.posterior
┌ 100×4×3×2 Dataset ┐
├───────────────────┴─────────────────────────────────── dims ┐
↓ draw ,
├───────────────────┴───────────────────────────────────────── dims ┐
↓ draw,
→ chain,
↗ a_dim Categorical{String} ["x", "y", "z"] ForwardOrdered,
↗ a_dim Categorical{String} ["x", …, "z"] ForwardOrdered,
⬔ run
├─────────────────────────────────────────────────────────────┴ layers ┐
├─────────────────────────────────────────────────────────── layers ┤
:a eltype: Float64 dims: draw, chain, a_dim, run size: 100×4×3×2
:b eltype: Float64 dims: draw, chain, run size: 100×4×2
├──────────────────────────────────────────────────────────── metadata ┤
├───────────────────────────────────────────────────────── metadata ┤
Dict{String, Any} with 1 entry:
"created_at" => "2025-02-04T10:49:16.704"
"created_at" => "2025-07-25T10:11:18.92"

julia> idata_cat3.observed_data
┌ 10-element Dataset ┐
├────────────── dims ┤
├────────────────────┴───────────────── dims ┐
↓ y_dim_1
├────────────────────┴─────────────── layers ┐
├──────────────────────────────────── layers ┤
:y eltype: Float64 dims: y_dim_1 size: 10
├────────────────────────────────────────────┴ metadata ┐
Dict{String, Any} with 1 entry:
"created_at" => "2025-02-04T10:49:16.71"
"created_at" => "2025-07-25T10:11:18.951"
```
"""
function Base.cat(data::InferenceData, others::InferenceData...; groups=keys(data), dims)
Expand Down
Loading