dec-pomdp-diagnostics 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- dec_pomdp_diagnostics-0.1.0/LICENSE +201 -0
- dec_pomdp_diagnostics-0.1.0/PKG-INFO +278 -0
- dec_pomdp_diagnostics-0.1.0/README.md +245 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/__init__.py +76 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/__main__.py +5 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/api.py +704 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/cli.py +215 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/data.py +479 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/estimators.py +581 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/metrics.py +707 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/pipeline.py +277 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/summary.py +294 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics/wandb_collect.py +372 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics.egg-info/PKG-INFO +278 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics.egg-info/SOURCES.txt +22 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics.egg-info/dependency_links.txt +1 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics.egg-info/entry_points.txt +3 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics.egg-info/requires.txt +13 -0
- dec_pomdp_diagnostics-0.1.0/dec_pomdp_diagnostics.egg-info/top_level.txt +1 -0
- dec_pomdp_diagnostics-0.1.0/pyproject.toml +59 -0
- dec_pomdp_diagnostics-0.1.0/setup.cfg +4 -0
- dec_pomdp_diagnostics-0.1.0/tests/test_aggregation.py +245 -0
- dec_pomdp_diagnostics-0.1.0/tests/test_synthetic_metrics.py +401 -0
- dec_pomdp_diagnostics-0.1.0/tests/test_user_api.py +229 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: dec-pomdp-diagnostics
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Information-theoretic diagnostics for cooperative MARL Dec-POMDPs (Tessera et al., AAMAS 2026).
|
|
5
|
+
Author-email: Kale-ab Abebe Tessera <kaleabtessera@gmail.com>
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Paper, https://arxiv.org/abs/2602.20804
|
|
8
|
+
Project-URL: Repository, https://github.com/KaleabTessera/probing-dec-pomdps
|
|
9
|
+
Project-URL: Website, https://www.kaleabtessera.com/probing
|
|
10
|
+
Keywords: multi-agent reinforcement learning,Dec-POMDP,cooperative MARL,mutual information,diagnostics
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Requires-Dist: numpy>=1.24
|
|
22
|
+
Requires-Dist: scipy>=1.10
|
|
23
|
+
Requires-Dist: scikit-learn>=1.2
|
|
24
|
+
Requires-Dist: pandas>=2.0
|
|
25
|
+
Requires-Dist: joblib>=1.3
|
|
26
|
+
Requires-Dist: rliable>=1.0
|
|
27
|
+
Provides-Extra: collect
|
|
28
|
+
Requires-Dist: wandb>=0.16; extra == "collect"
|
|
29
|
+
Provides-Extra: dev
|
|
30
|
+
Requires-Dist: pytest>=7; extra == "dev"
|
|
31
|
+
Requires-Dist: ruff>=0.4; extra == "dev"
|
|
32
|
+
Dynamic: license-file
|
|
33
|
+
|
|
34
|
+
# Probing Dec-POMDP Reasoning in Cooperative MARL
|
|
35
|
+
|
|
36
|
+
<p align="center">
|
|
37
|
+
<a href="https://arxiv.org/abs/2602.20804"><img alt="Paper" src="https://img.shields.io/badge/Paper-arXiv%3A2602.20804-b31b1b" /></a>
|
|
38
|
+
<a href="https://www.kaleabtessera.com/probing"><img alt="Website" src="https://img.shields.io/badge/Project-Website-0f766e" /></a>
|
|
39
|
+
<a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/License-Apache--2.0-2563eb" /></a>
|
|
40
|
+
</p>
|
|
41
|
+
<p align="center">
|
|
42
|
+
<img src="hero.svg" alt="Pipeline: train policies, collect rollouts, compute probes, audit behaviours" width="100%" />
|
|
43
|
+
</p>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
Metrics introduced in [Probing Dec-POMDP Reasoning in Cooperative MARL](https://arxiv.org/abs/2602.20804) (Oral, AAMAS 2026).
|
|
48
|
+
|
|
49
|
+
This repository provides information-theoretic diagnostics for cooperative MARL trajectories. Given trained-policy rollouts, the package computes five probes, compares them against permutation nulls, and helps audit what behaviours are induced under the policy distribution rather than relying only on return.
|
|
50
|
+
|
|
51
|
+
Use it when you want to ask:
|
|
52
|
+
|
|
53
|
+
- Do actions depend on memory beyond the current observation?
|
|
54
|
+
- Does one agent carry private information that predicts another agent's action?
|
|
55
|
+
- Is coordination mostly synchronous action coupling, or is there temporal influence across agents?
|
|
56
|
+
|
|
57
|
+
Quick links: [Installation](#installation) | [Quickstart](#quickstart) | [CLI](#cli-reference) | [Citation](#citation)
|
|
58
|
+
|
|
59
|
+
## The five diagnostics
|
|
60
|
+
|
|
61
|
+
For agent $i$ at time $t$, let $O_t^i$ denote the local observation, $A_t^i$ the action, $H_t^i$ the history representation, and $\tau_{t-1}^i$ the action-observation history up to $t-1$. For recurrent policies, $H_t^i$ is the RNN hidden state. For feed-forward policies, history is approximated using a length-$k$ window, such as $O_{t-k:t-1}^i$ or $(O_{t-k:t-1}^i, A_{t-k:t-1}^i)$, depending on the diagnostic.
|
|
62
|
+
|
|
63
|
+
All diagnostics measure predictive statistical dependence under the rollout distribution, not causal influence and not worst-case/best-case properties of the environment. They should be interpreted together with the memory-reactive performance gap, permutation-null baselines, bootstrap uncertainty, and behavioural evaluations.
|
|
64
|
+
|
|
65
|
+
| Diagnostic | Definition | If high, suggests… | Implementation |
|
|
66
|
+
|---|---|---|---|
|
|
67
|
+
| **OAR** | $I(O_t^i; A_t^i)$ | The current observation is highly predictive of the agent’s action. This is consistent with more **reactive behaviour**, especially when **HAR** is low. | `compute_oar` |
|
|
68
|
+
| **HAR** | $I(H_t^i; A_t^i \mid O_t^i)$ | The agent’s action depends on history beyond the current observation. This indicates **history-dependent behaviour**, but not necessarily performance-critical memory use ($\Delta_{\mathrm{Mem}}$ can help with that). | `compute_har_hidden` (RNN), `compute_har_ohist` (FF) |
|
|
69
|
+
| **PIF** | $I(\tau_{t-1}^i, O_t^i; A_t^j \mid \tau_{t-1}^j, O_t^j)$ | Agent $i$'s trajectory and current observation contain additional predictive information about agent $j$'s action beyond $j$'s own history and observation. This is consistent with **cross-agent information asymmetry**, where one agent’s information helps predict another agent’s behaviour.| `compute_pif_hidden` (RNN), `compute_pif_oa_hist` (FF) |
|
|
70
|
+
| **AA** | $I(A_t^i; A_t^j \mid O_t^i, O_t^j)$ | Residual same-timestep action dependence remains after conditioning on both agents’ current observations. This is consistent with **instantaneous conventions**, **symmetry breaking**, or shared unobserved drivers. | `compute_aa` |
|
|
71
|
+
| **DAI** | $T^{-1}\sum_t I(\tau_{t-1}^i; A_t^j \mid \tau_{t-1}^j)$ | Agent $i$'s past provides additional predictive information about agent $j$'s future action beyond $j$'s own past. This is consistent with **temporally directed dependence**. | `compute_dai_hidden` (RNN), `compute_dai_oa_hist` (FF) |
|
|
72
|
+
|
|
73
|
+
Each diagnostic also has a normalised form in $[0, 1]$, obtained by dividing by the relevant action entropy or residual action entropy:
|
|
74
|
+
|
|
75
|
+
- **OAR**: divided by $H(A_t^i)$.
|
|
76
|
+
- **HAR**: divided by $H(A_t^i \mid O_t^i)$.
|
|
77
|
+
- **PIF**: divided by $H(A_t^j \mid \tau_{t-1}^j, O_t^j)$.
|
|
78
|
+
- **AA**: divided by $H(A_t^j \mid O_t^i, O_t^j)$.
|
|
79
|
+
- **DAI**: divided by $T^{-1}\sum_t H(A_t^j \mid \tau_{t-1}^j)$.
|
|
80
|
+
|
|
81
|
+
We also compute a permutation-null baseline for each diagnostic. The action sequence is shuffled within each agent, preserving marginal action statistics while destroying temporal and cross-agent dependencies. A diagnostic is treated as **above-null** only when its value on the original trajectories exceeds the mean over null replicates. This helps account for finite-sample bias and noise in MI estimators.
|
|
82
|
+
|
|
83
|
+
The **memory-reactive performance gap** $\Delta_{\mathrm{Mem}} = J(\pi_{\mathrm{RNN}}) - J(\pi_{\mathrm{FF}})$ is computed from training-time evaluation returns rather than trajectory data, so it lives outside this package.
|
|
84
|
+
|
|
85
|
+
## Installation
|
|
86
|
+
|
|
87
|
+
Requires Python ≥ 3.10. Core dependencies are NumPy, SciPy, scikit-learn, pandas, joblib, and rliable. The package is tested on Python 3.12.
|
|
88
|
+
|
|
89
|
+
Install the released package:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
pip install dec-pomdp-diagnostics
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Install from source for development:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
git clone https://github.com/KaleabTessera/probing-dec-pomdps.git
|
|
99
|
+
cd probing-dec-pomdps
|
|
100
|
+
pip install -e .
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Install test/development extras:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
pip install -e ".[dev]"
|
|
107
|
+
pytest
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Quickstart
|
|
111
|
+
|
|
112
|
+
If you already have MARL trajectories, you do not need the W&B pipeline. Wrap your arrays in `UserData`, call `compute_diagnostics` for each `(environment, algorithm, seed)` run, then use `build_paper_table` to aggregate results across scenarios.
|
|
113
|
+
|
|
114
|
+
Expected array shapes:
|
|
115
|
+
|
|
116
|
+
- `observations[agent]`: `(N, obs_dim)`
|
|
117
|
+
- `actions[agent]`: `(N,)` for discrete actions or `(N, act_dim)` for continuous actions
|
|
118
|
+
- `timesteps[agent]`: `(N,)`, integer step within episode
|
|
119
|
+
- `episode_ids[agent]`: `(N,)`, integer episode or parallel-env id
|
|
120
|
+
- `hidden_states[agent]`: optional `(N, hidden_dim)` for recurrent policies
|
|
121
|
+
|
|
122
|
+
```python
|
|
123
|
+
import numpy as np
|
|
124
|
+
import dec_pomdp_diagnostics as dpd
|
|
125
|
+
|
|
126
|
+
rng = np.random.default_rng(0)
|
|
127
|
+
# N = total steps, T = timesteps per episode
|
|
128
|
+
N, obs_dim, T = 1200, 8, 24
|
|
129
|
+
n_eps = N // T
|
|
130
|
+
obs0 = rng.normal(size=(N, obs_dim)).astype(np.float32)
|
|
131
|
+
obs1 = rng.normal(size=(N, obs_dim)).astype(np.float32)
|
|
132
|
+
act0 = rng.integers(0, 2, size=N, dtype=np.int64)
|
|
133
|
+
act1 = rng.integers(0, 2, size=N, dtype=np.int64)
|
|
134
|
+
ts = np.tile(np.arange(T, dtype=np.int64), n_eps)
|
|
135
|
+
eps = np.repeat(np.arange(n_eps, dtype=np.int64), T)
|
|
136
|
+
Sd = {"agent_0": obs0, "agent_1": obs1}
|
|
137
|
+
Td = {"agent_0": ts, "agent_1": ts}
|
|
138
|
+
Ed = {"agent_0": eps, "agent_1": eps}
|
|
139
|
+
|
|
140
|
+
# OAR: raw action arrays from rollouts.
|
|
141
|
+
Ad = {"agent_0": act0, "agent_1": act1}
|
|
142
|
+
oar, oar_norm = dpd.compute_oar(Sd, Ad)
|
|
143
|
+
print(oar_norm)
|
|
144
|
+
|
|
145
|
+
# HAR / PIF / AA / DAI use the same raw-array pattern.
|
|
146
|
+
har, har_norm = dpd.compute_har_ohist(Sd, Ad, Td, Ed, k_window=3)
|
|
147
|
+
pif, pif_norm, _ = dpd.compute_pif_oa_hist(Sd, Ad, Td, Ed, k_window=3)
|
|
148
|
+
aa, aa_norm, _ = dpd.compute_aa(Sd, Ad, Td, Ed)
|
|
149
|
+
dai, dai_norm, _ = dpd.compute_dai_oa_hist(Sd, Ad, Td, Ed, k_window=3)
|
|
150
|
+
|
|
151
|
+
result = dpd.compute_diagnostics(
|
|
152
|
+
dpd.UserData(
|
|
153
|
+
observations={"agent_0": obs0, "agent_1": obs1},
|
|
154
|
+
actions={"agent_0": act0, "agent_1": act1},
|
|
155
|
+
timesteps={"agent_0": ts, "agent_1": ts},
|
|
156
|
+
episode_ids={"agent_0": eps, "agent_1": eps},
|
|
157
|
+
env_name="my_env",
|
|
158
|
+
alg_name="IPPO",
|
|
159
|
+
seed=0,
|
|
160
|
+
),
|
|
161
|
+
history_k=3,
|
|
162
|
+
null_reps=5,
|
|
163
|
+
)
|
|
164
|
+
print(result.describe())
|
|
165
|
+
# Run my_env/IPPO/seed0:
|
|
166
|
+
# ✗ Do actions depend on history? (Diag 2: HAR^norm > permutation null, HAR^norm=0.0430, HAR^null=0.0442)
|
|
167
|
+
# ✗ Does teammate information help predict another agent's actions? (Diag 4: PIF^norm > null, PIF^norm=0.0377, PIF^null=0.0355)
|
|
168
|
+
# ✗ Does synchronous coordination emerge? (Diag 5: AA^norm > null, AA^norm=0.0278, AA^null=0.0278)
|
|
169
|
+
# ✗ Does temporal coordination emerge? (Diag 6: DAI^norm > null, DAI^norm=0.0365, DAI^null=0.0360)
|
|
170
|
+
# Note: flags are guidance, not strict pass/fail; using min_effect=0.0100
|
|
171
|
+
# Table values: OAR^norm=0.0165, HAR^norm=0.0430, PIF^norm=0.0377, AA^norm=0.0278, DAI^norm=0.0365
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
For the full **memory–reactive performance gap** (Diagnostic 1), pair the
|
|
175
|
+
mean evaluation returns of matched RNN/FF seeds:
|
|
176
|
+
|
|
177
|
+
```python
|
|
178
|
+
gap = dpd.memory_reactive_gap(rnn_returns=[...], ff_returns=[...])
|
|
179
|
+
# {'delta_mean': 6.50, 'p_value': 0.031, 'benefits_from_memory': True, 'n_pairs': 10}
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Pass `memory_gap_flags={env_name: gap['benefits_from_memory']}` to
|
|
183
|
+
`build_paper_table` to combine it with the HAR-uses-history check, matching
|
|
184
|
+
Decision Rule 1 exactly.
|
|
185
|
+
|
|
186
|
+
### What `compute_diagnostics` does for you
|
|
187
|
+
|
|
188
|
+
* **Validates** shapes, dtypes, and key consistency — clear errors if obs is
|
|
189
|
+
1D, timesteps are float, or agent keys don't match across fields.
|
|
190
|
+
* Picks the right estimator per metric (Frenzel-Pompe KSG for continuous
|
|
191
|
+
actions, posterior-KL for discrete, Ross 2014 for low-D OAR).
|
|
192
|
+
* Auto-detects continuous vs discrete actions; override with
|
|
193
|
+
`force_continuous_A=True` if needed.
|
|
194
|
+
* Subsamples per agent jointly (preserving cross-agent alignment) when
|
|
195
|
+
trajectories are long; defaults to ≤ 8000 samples.
|
|
196
|
+
* Runs the **permutation null** (shuffle each agent's actions independently)
|
|
197
|
+
and applies Decision Rules 2-4 directly: a flag is True iff the metric
|
|
198
|
+
exceeds its null mean by at least `min_effect` (default `0.01`).
|
|
199
|
+
|
|
200
|
+
### Interpreting the outputs
|
|
201
|
+
|
|
202
|
+
The flags are diagnostic guidance, not hard pass/fail labels. A metric can be large because the trained policies expose a behavioural dependence under the sampled rollout distribution; a different algorithm, architecture, or training seed may induce a different diagnostic profile in the same scenario. Borderline effects should be read with the reported null baselines and confidence intervals.
|
|
203
|
+
|
|
204
|
+
## Project layout
|
|
205
|
+
|
|
206
|
+
```
|
|
207
|
+
dec_pomdp_diagnostics/
|
|
208
|
+
├── api.py # USER-FACING: UserData, compute_diagnostics, build_paper_table, memory_reactive_gap
|
|
209
|
+
├── estimators.py # kNN MI/CMI building blocks (KSG, Frenzel-Pompe, Ross, posterior-KL)
|
|
210
|
+
├── metrics.py # The five diagnostics (lower-level, dict-of-arrays API)
|
|
211
|
+
├── data.py # Dataset loading, packed-format unpacking, alignment, subsampling
|
|
212
|
+
├── pipeline.py # Per-run orchestration + permutation null
|
|
213
|
+
├── summary.py # rliable bootstrap CIs + LaTeX table (replication mode)
|
|
214
|
+
├── wandb_collect.py # Optional W&B artifact downloader
|
|
215
|
+
├── cli.py # `dec-pomdp-metrics` and `dec-pomdp-collect`
|
|
216
|
+
└── __init__.py # Top-level exports
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
## CLI reference
|
|
220
|
+
|
|
221
|
+
```bash
|
|
222
|
+
dec-pomdp-metrics --help
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
Common flags:
|
|
226
|
+
|
|
227
|
+
* `--metrics oar har pif aa dai` — subset of diagnostics to compute (default: all)
|
|
228
|
+
* `--history-k 3` — observation/action history window length (paper default)
|
|
229
|
+
* `--cmi-k 25` — kNN neighbours for the CMI estimator (paper default)
|
|
230
|
+
* `--posterior-alpha 0.5` — Laplace smoothing for discrete-action kNN posteriors
|
|
231
|
+
* `--null-reps 5` — permutation-null replicates per run (paper default)
|
|
232
|
+
* `--parallel --n-jobs 24` — joblib parallelism over runs
|
|
233
|
+
* `--max-samples 8000` — joint subsampling per agent (preserves cross-agent alignment)
|
|
234
|
+
* `--force-continuous-A` — required for continuous-action environments (e.g. MaBrax)
|
|
235
|
+
* `--env <name> ... --alg <name> ...` — filter to a subset
|
|
236
|
+
|
|
237
|
+
The output is three files: ``<input>_metrics_<set>.csv`` (per-run rows),
|
|
238
|
+
``..._summary.csv`` (per-(env, alg) bootstrap CIs), and ``..._table.tex``
|
|
239
|
+
(LaTeX table in the paper format).
|
|
240
|
+
|
|
241
|
+
### Troubleshooting exact zeros
|
|
242
|
+
|
|
243
|
+
If OAR/HAR/PIF/AA/DAI are unexpectedly all zero, check the runtime warnings.
|
|
244
|
+
For discrete actions with many encoded classes, the posterior-kNN estimators
|
|
245
|
+
can be over-smoothed when ``posterior_alpha * n_action_classes`` is large
|
|
246
|
+
relative to ``cmi_k``. This is especially easy to hit with high-dimensional
|
|
247
|
+
observations and sparse/non-compact action IDs. Try lowering
|
|
248
|
+
``--posterior-alpha`` (for example ``0.01``), increasing ``--cmi-k`` and/or
|
|
249
|
+
``--max-samples``, and verifying that action IDs are compact and intentional.
|
|
250
|
+
|
|
251
|
+
For recurrent policies, make sure hidden states are present. If ``alg_name``
|
|
252
|
+
contains ``RNN`` but ``UserData.hidden_states`` is omitted, the library warns
|
|
253
|
+
and reports the feed-forward observation-history proxy metrics rather than
|
|
254
|
+
hidden-state HAR/PIF/DAI.
|
|
255
|
+
|
|
256
|
+
## Tests
|
|
257
|
+
|
|
258
|
+
The test suite includes synthetic sanity checks where each diagnostic should
|
|
259
|
+
be high under a designed dependency and low under an independent control, for
|
|
260
|
+
both discrete and continuous actions:
|
|
261
|
+
|
|
262
|
+
```bash
|
|
263
|
+
pip install -e ".[dev]"
|
|
264
|
+
pytest tests/test_synthetic_metrics.py
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
## Citation
|
|
268
|
+
|
|
269
|
+
```bibtex
|
|
270
|
+
@inproceedings{
|
|
271
|
+
tessera2026probing,
|
|
272
|
+
title={Probing Dec-{POMDP} Reasoning in Cooperative {MARL}},
|
|
273
|
+
author={{Kale-ab} Abebe Tessera and Leonard Hinckeldey and Riccardo Zamboni and David Abel and Amos Storkey},
|
|
274
|
+
booktitle={The 25th International Conference on Autonomous Agents and Multi-Agent Systems},
|
|
275
|
+
year={2026},
|
|
276
|
+
url={https://openreview.net/forum?id=gSK8tR7du3}
|
|
277
|
+
}
|
|
278
|
+
```
|