Skip to content

Commit 29019d1

Browse files
committed
chore(README): update README to match the addition of the transformations module
1 parent 499d3f6 commit 29019d1

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![CI][status-shield]][status-url]
99
[![MIT License][license-shield]][license-url]
1010

11-
**PySATL Core** is the computational core of the PySATL project, providing abstractions and infrastructure for probability distributions, parametric families, characteristic-based computations, and sampling.
11+
**PySATL Core** is the computational core of the PySATL project, providing abstractions and infrastructure for probability distributions, parametric families, characteristic-based computations, transformations, and sampling.
1212

1313
The library is designed as a **foundational kernel** rather than a ready-to-use end-user package. Its primary goals are explicit probabilistic structure, extensibility, and suitability as a basis for further stochastic and statistical tooling.
1414

@@ -26,6 +26,9 @@ The library is designed as a **foundational kernel** rather than a ready-to-use
2626
- A global **family registry** for configuring, querying, and extending available distribution families.
2727
- **Characteristic computation graph** (`CharacteristicRegistry`) that allows computing
2828
arbitrary characteristics by specifying only a minimal analytical subset.
29+
- **Transformations module** for derived distributions:
30+
affine transformations (`aX + b`), binary operations (`X ± Y`, `X * Y`, `X / Y`),
31+
finite weighted mixtures, and characteristic-level approximations.
2932
- Distribution objects exposing common probabilistic operations
3033
(sampling, analytical and fitted computations).
3134
- Clear separation between *distribution definitions*, *parametrizations*,
@@ -110,6 +113,16 @@ This example uses a **predefined family** and **predefined parametrizations**.
110113
PySATL Core also supports defining custom families, parametrizations,
111114
and characteristic graphs.
112115

116+
For transformation workflows, see `examples/transformations_overview.ipynb`.
117+
118+
---
119+
120+
## 📓 Notebooks
121+
122+
- `examples/overview.ipynb` — base walkthrough for families, parametrizations, and characteristic queries.
123+
- `examples/transformations_overview.ipynb` — affine, binary, finite-mixture, and approximation workflows.
124+
- `examples/example_sampling_methods.ipynb` — sampling backends and UNURAN-oriented scenarios.
125+
113126
---
114127

115128
## 📖 Documentation
@@ -143,7 +156,7 @@ poetry run pre-commit run --all-files
143156

144157
## 🗺 Roadmap
145158

146-
- **Transformations module** for mixtures and distribution transformations.
159+
- Extension of the transformations module (functional transforms, performance improvements).
147160
- Extension of characteristic graphs.
148161
- Stabilization of APIs and **publishing PySATL Core as an installable package**.
149162

0 commit comments

Comments
 (0)