partworth 0.0.1__tar.gz

partworth-0.0.1/.gitignore

@@ -0,0 +1,17 @@
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+# third-party data is fetched at runtime and never committed
+data/
+*.rda
+*.RData
+
+# bayesm outputs at respondent level are derived from GPL-distributed data
+validation/results/bayesm_*.csv

partworth-0.0.1/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## 0.0.1 (2026-10-14)
+
+First release on PyPI.
+
+- `ChoiceData.from_long`: validated long-format input, ragged tasks/alternatives, none
+  option, respondent covariates, `subset`, `holdout`, `describe`
+- Effects, dummy and linear coding with sign constraints
+- `HierarchicalMNL`: non-centred hierarchical MNL with LKJ covariance, covariate
+  regression of the population mean, lognormal sign constraints, nutpie or PyMC NUTS
+- `HBResult`: part-worths, zero-centred diffs, importances, RLH, population summary,
+  diagnostics with guidance, hold-out prediction, Sawtooth-style CSV, save/load
+- `MarketSimulator` (logit and first choice, credible intervals, weights, price curves,
+  shares for each posterior draw with `share_draws`) and `wtp`
+- `datasets.load_camera` (fetched from CRAN at run time) and `datasets.simulate_cbc`
+- Validation against R bayesm (`validation/`)
+- Example notebooks on a dummy retail survey, in English and Japanese (`examples/`)

partworth-0.0.1/CITATION.cff

@@ -0,0 +1,14 @@
+cff-version: 1.2.0
+message: "If you use partworth, please cite it as below."
+title: "partworth: hierarchical Bayes choice-based conjoint analysis in Python"
+authors:
+  - family-names: Miyazawa
+    given-names: Koji
+license: Apache-2.0
+repository-code: "https://github.com/kojikojikojikoji/partworth"
+version: 0.0.1
+keywords:
+  - conjoint analysis
+  - discrete choice
+  - hierarchical Bayes
+  - PyMC

partworth-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+Issues and pull requests are welcome, especially:
+
+- comparisons with other software (Sawtooth CBC/HB, bayesm, apollo, Biogeme) on data you
+  can share;
+- public CBC data sets that could become examples;
+- reports of convergence problems with a reproducible (simulated or public) example.
+
+## Ground rules
+
+- **Public or simulated data only.** Do not add examples, fixtures or attribute sets
+  derived from non-public studies (see `docs/adr/0001-clean-room-and-sources.md`).
+- **No GPL code.** Do not port code from bayesm, apollo or other GPL packages. Comparing
+  against them from `validation/` in a separate process is fine.
+- Record design decisions that change behaviour in a new ADR under `docs/adr/`.
+
+## Development
+
+```
+uv venv --python 3.12 && uv pip install -e ".[dev]"
+pytest -q                       # fast unit tests
+pytest -q --run-slow            # MCMC tests (parameter recovery), a few minutes
+pytest -q --run-network         # tests that download the camera data
+ruff check src tests validation
+```
+
+Validation scripts (need more time; `compare_camera.py` also needs R with bayesm):
+
+```
+python validation/compare_camera.py
+python validation/sbc.py --reps 200
+python validation/performance.py
+```
+
+On macOS 26+ with PyTensor 3.3.3 or earlier, set `PYTENSOR_FLAGS=cxx=` (see README).

partworth-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

partworth-0.0.1/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.5
+Name: partworth
+Version: 0.0.1
+Summary: Hierarchical Bayes choice-based conjoint analysis in Python, with Sawtooth-style outputs and a market simulator
+Project-URL: Homepage, https://github.com/kojikojikojikoji/partworth
+Project-URL: Issues, https://github.com/kojikojikojikoji/partworth/issues
+Author: Koji Miyazawa
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: choice-based conjoint,conjoint,discrete choice,hierarchical bayes,market research,pymc
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.12
+Requires-Dist: arviz<2,>=1.3
+Requires-Dist: h5netcdf>=1.3
+Requires-Dist: h5py>=3.10
+Requires-Dist: numpy>=1.26
+Requires-Dist: pandas>=2.2
+Requires-Dist: pymc<7,>=6.3
+Requires-Dist: xarray>=2024.10
+Provides-Extra: datasets
+Requires-Dist: rdata>=0.11; extra == 'datasets'
+Provides-Extra: dev
+Requires-Dist: nutpie>=0.16; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: rdata>=0.11; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: tabulate>=0.9; extra == 'dev'
+Provides-Extra: nutpie
+Requires-Dist: nutpie>=0.16; extra == 'nutpie'
+Provides-Extra: pmm
+Requires-Dist: pymc-marketing>=1.2; extra == 'pmm'
+Description-Content-Type: text/markdown
+
+# partworth
+
+partworth estimates hierarchical Bayes (HB) models for choice-based conjoint (CBC)
+studies in Python. It is built on [PyMC](https://www.pymc.io/).
+
+It covers the whole workflow in one package: data checks, HB estimation, respondent-level
+part-worths, Sawtooth-style output files, a market simulator and willingness to pay (WTP).
+The validation scripts and their results are in the repository.
+
+> **Status: pre-alpha.** The API may change.
+
+## What you can do with it
+
+```mermaid
+flowchart TB
+    subgraph S1["1. Your survey"]
+        direction LR
+        A["CBC answers<br/>(long format)"]
+        B["Design from ChoiceDesign<br/>(wide format)"]
+        A ~~~ B
+    end
+    subgraph S2["2. Fit one model"]
+        direction LR
+        C["ChoiceData<br/>checks the data"] --> D["HierarchicalMNL<br/>HB estimation on PyMC"] --> E["Diagnostics<br/>R-hat, ESS, divergences"]
+    end
+    subgraph S3["3. Read the results"]
+        direction LR
+        F["Part-worths<br/>for each respondent"]
+        G["Importances and RLH"]
+        H["Sawtooth-style CSV"]
+        F ~~~ G ~~~ H
+    end
+    subgraph S4["4. Answer business questions"]
+        direction LR
+        I["Which product wins?<br/>shares with<br/>credible intervals"]
+        J["What if we change<br/>the price?<br/>price curves"]
+        K["How much will<br/>people pay?<br/>WTP for a feature"]
+        I ~~~ J ~~~ K
+    end
+    S1 --> S2 --> S3 --> S4
+```
+
+Steps 1 to 3 replace the usual "estimate in one tool, export, simulate in a spreadsheet" work.
+Step 4 uses all posterior draws, so every share, price curve and WTP comes with its uncertainty.
+
+## Why partworth
+
+- Sawtooth CBC/HB is commercial and runs outside Python. partworth gives the same kind of
+  outputs (raw utilities, zero-centred diffs, importances, RLH) in an open Python package.
+- pymc-marketing's `MixedLogit` is a general choice model. partworth is built for CBC
+  studies: long-format survey data, correlated random coefficients, a negative price
+  coefficient for every respondent, and a simulator with credible intervals.
+- Each result can be checked. The repository compares partworth with R `bayesm` on public
+  data and tests that it recovers known parameters.
+
+## What works now
+
+- Long-format choice data with checks, tasks of different sizes and a none option
+- Import of wide designs, such as the output of [ChoiceDesign](https://choicedesign.readthedocs.io/)
+- Effects, dummy and linear coding, with an optional sign constraint (for price)
+- Hierarchical MNL with correlated coefficients (LKJ prior), respondent covariates and the
+  nutpie sampler
+- Part-worths, zero-centred diffs, importances, RLH and convergence diagnostics
+- Sawtooth-style utilities CSV (read and write)
+- Market simulator with credible intervals, price curves and WTP
+
+Not planned: experimental design (use ChoiceDesign),
+latent class, MaxDiff and ACBC.
+
+## Installation
+
+```
+pip install "partworth[nutpie,datasets]"
+```
+
+`nutpie` adds the faster sampler. `datasets` adds the reader for the public camera data.
+
+It needs Python 3.12 or later.
+
+On macOS 26 or later, PyTensor 3.3.3 or earlier can fail with
+`ld: library 'd64' not found`. Set `PYTENSOR_FLAGS=cxx=` to avoid it. The fix is merged in
+PyTensor ([pymc-devs/pytensor#2432](https://github.com/pymc-devs/pytensor/pull/2432)) but
+not yet released.
+
+## Quick look
+
+This example uses simulated data, so you can paste it as it is.
+
+```python
+import pandas as pd
+import partworth as pw
+from partworth.datasets import simulate_cbc
+
+# 300 respondents, 12 tasks, 3 products + "none" per task.
+# mu: true population means of the coded coefficients (price on the log scale).
+data, truth = simulate_cbc(
+    300, 12, 3,
+    {"brand": ["A", "B", "C"], "size": ["S", "M", "L"], "price": [2.0, 2.5, 3.0, 3.5]},
+    price="price", mu=[0.4, -0.1, -0.3, 0.1, -0.5, -1.0], sd=0.6, seed=1,
+)
+print(data.describe())                       # how often each level was shown and chosen
+
+# more tuning and draws than the defaults: the SD of "none" mixes slowly (see the guide)
+result = pw.HierarchicalMNL(data).fit(draws=2000, tune=3000, chains=4, random_seed=1)
+print(result.diagnostics().report())         # R-hat, ESS, divergences, what to try
+
+result.part_worths()                         # raw utilities, one column per level
+result.part_worths("zc_diffs")               # zero-centred diffs
+result.importances()
+result.to_sawtooth_csv("utilities.csv")
+
+scenario = pd.DataFrame({"product": ["Ours", "Theirs"], "brand": ["A", "B"],
+                         "size": ["M", "M"], "price": [3.0, 2.5]})
+sim = pw.MarketSimulator(result)
+print(sim.shares(scenario))                  # shares with 90% credible intervals
+print(sim.price_curve(scenario, product="Ours", grid=[2.0, 2.5, 3.0, 3.5]))
+print(pw.wtp(result, attribute="size", from_level="S", to_level="L"))
+```
+
+For your own data, build `ChoiceData` from a long table (one row per respondent, task and
+alternative):
+
+```python
+data = pw.ChoiceData.from_long(
+    df,                                        # your table
+    attributes={"brand": pw.Categorical(["A", "B", "C"]),
+                "price": pw.Linear(sign="negative")},
+    none="is_none",                            # optional "no purchase" rows
+)
+```
+
+[examples/retail_survey.ipynb](https://github.com/kojikojikojikoji/partworth/blob/main/examples/retail_survey.ipynb) is a notebook on a dummy retail
+survey. It goes from the survey table to shares, prices and profit. A Japanese version is in
+[examples/retail_survey_ja.ipynb](https://github.com/kojikojikojikoji/partworth/blob/main/examples/retail_survey_ja.ipynb).
+[examples/camera.py](https://github.com/kojikojikojikoji/partworth/blob/main/examples/camera.py) runs the same steps on public data.
+[docs/guide.md](https://github.com/kojikojikojikoji/partworth/blob/main/docs/guide.md) explains the choices you make along the way.
+
+## Validation
+
+Each script in [validation/](https://github.com/kojikojikojikoji/partworth/tree/main/validation/) writes its report to
+[validation/results/](https://github.com/kojikojikojikoji/partworth/tree/main/validation/results/).
+
+- **Parameter recovery** ([recovery_report.md](https://github.com/kojikojikojikoji/partworth/blob/main/validation/results/recovery_report.md)).
+  300 simulated respondents and 12 tasks. Respondent-level 90% intervals covered 88.7% of
+  the true values. 5 of 6 population means and 6 of 6 SDs were inside their 90%
+  intervals. The price mean (log scale) was just outside. The convergence targets were met.
+  Correlations reached R-hat 1.013 and ESS 399, just short of the targets.
+  `pytest --run-slow` runs the same fit and checks.
+- **Comparison with R bayesm** ([camera_report.md](https://github.com/kojikojikojikoji/partworth/blob/main/validation/results/camera_report.md)).
+  `bayesm::rhierMnlRwMixture` on the public camera data. Respondent-level posterior means
+  correlate at 0.997 or more for every coefficient. The hold-out hit rate is 0.729 for
+  partworth and 0.730 for bayesm. Population means differ by up to 0.21 posterior SDs.
+  Our target was 0.1, so this target is not met. The two packages use different priors.
+- **Simulation-based calibration** ([sbc_report.md](https://github.com/kojikojikojikoji/partworth/blob/main/validation/results/sbc_report.md)).
+  200 simulated data sets, 8 population parameters. The smallest uniformity p-value was
+  0.017. None was below 0.006, the threshold after correcting for 8 tests. Earlier runs
+  showed low p-values for different parameters each time. 15 of the 200 fits had a
+  population ESS below 99, which weakens the check.
+- **Performance** ([performance.md](https://github.com/kojikojikojikoji/partworth/blob/main/validation/results/performance.md)). 300 respondents
+  took 74 s and 1,000 respondents took 290 s on one laptop.
+
+## Data and licences
+
+partworth is licensed under Apache-2.0. The `camera` data belongs to the R package
+[bayesm](https://cran.r-project.org/package=bayesm), which is GPL. partworth downloads it
+from CRAN on first use and never includes it. No bayesm code is used. The comparison runs
+R in a separate process.
+
+All examples use public or simulated data.
+
+## How this is built
+
+Design decisions are in [docs/adr/](https://github.com/kojikojikojikoji/partworth/tree/main/docs/adr/). Parts of the code were written with an AI
+coding assistant. The model, the priors and the validation targets are the author's
+decisions. The ADRs record them.
+
+## Licence
+
+Apache License 2.0. See [LICENSE](https://github.com/kojikojikojikoji/partworth/blob/main/LICENSE).