Skip to content

Commit 4b17b9b

Browse files
committed
Release notes
1 parent a681965 commit 4b17b9b

3 files changed

Lines changed: 73 additions & 2 deletions

File tree

docs/release-notes.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,77 @@ below maps to a tagged release on
66
pushed, the matching section is extracted by
77
`.github/workflows/release.yml` and published as the GitHub Release body.
88

9+
## v1.0.0
10+
11+
First major release, consolidating the API for the 1.x series: a new
12+
distributions package, a rewritten Kalman filtering module, an expanded
13+
interest-rate toolkit and leaner naming across the options API. Several
14+
modules were renamed, reworked or removed: see **Breaking changes** before
15+
upgrading.
16+
17+
### Breaking changes
18+
19+
- New `quantflow.dists` package: `Marginal1D` moved there from
20+
`quantflow.utils.marginal`, and the 1D distributions from
21+
`quantflow.utils.distributions`; update imports accordingly
22+
([#80](https://github.com/quantmind/quantflow/pull/80)).
23+
- `implied_vol`/`implied_vols` fields and arguments renamed to `iv` across the
24+
options surface, calibration and plotting APIs
25+
([#67](https://github.com/quantmind/quantflow/pull/67)).
26+
- Kalman filtering rewritten: the old `quantflow.ta.kalman` module was removed
27+
and replaced by a state-space API with `LinearGaussianModel`, `KalmanFilter`
28+
and `UnscentedKalmanFilter`
29+
([#76](https://github.com/quantmind/quantflow/pull/76),
30+
[#79](https://github.com/quantmind/quantflow/pull/79)).
31+
- Options inputs and strategies reworked, with moneyness utilities moved into
32+
the new `quantflow.options.moneyness` module
33+
([#68](https://github.com/quantmind/quantflow/pull/68)).
34+
- Interest-rate package overhaul: CIR and Vasicek models expanded,
35+
Nelson-Siegel slimmed down, new no-discount curve
36+
([#74](https://github.com/quantmind/quantflow/pull/74)).
37+
- The `quantflow.ai` package was removed
38+
([#75](https://github.com/quantmind/quantflow/pull/75)).
39+
- EWMA alpha/period conversion corrected; results change for code relying on
40+
the previous formula
41+
([#73](https://github.com/quantmind/quantflow/pull/73)).
42+
43+
### New features
44+
45+
- Interpolated yield curves
46+
([#81](https://github.com/quantmind/quantflow/pull/81)).
47+
- Historical calibration of interest-rate models
48+
([#77](https://github.com/quantmind/quantflow/pull/77)).
49+
- Yield-curve fitting of forward and discount factors
50+
([#63](https://github.com/quantmind/quantflow/pull/63)).
51+
- Yahoo Finance volatility-surface loader
52+
([#61](https://github.com/quantmind/quantflow/pull/61)).
53+
54+
### Improvements and fixes
55+
56+
- Increased test coverage across the package, the app and the CIR curves
57+
([#69](https://github.com/quantmind/quantflow/pull/69),
58+
[#70](https://github.com/quantmind/quantflow/pull/70),
59+
[#71](https://github.com/quantmind/quantflow/pull/71)).
60+
- Documentation examples are now built once in CI and shared by the
61+
multi-arch image builds
62+
([#82](https://github.com/quantmind/quantflow/pull/82)).
63+
- Dependency updates, including aio-fluid
64+
([#78](https://github.com/quantmind/quantflow/pull/78)).
65+
66+
### Documentation and assets
67+
68+
- Docs improvements: plotly charts, example fixtures relocated, frontend
69+
moved, CIR and Vasicek rates API pages
70+
([#62](https://github.com/quantmind/quantflow/pull/62),
71+
[#64](https://github.com/quantmind/quantflow/pull/64),
72+
[#65](https://github.com/quantmind/quantflow/pull/65),
73+
[#66](https://github.com/quantmind/quantflow/pull/66),
74+
[#72](https://github.com/quantmind/quantflow/pull/72)).
75+
- Code of conduct added
76+
([#83](https://github.com/quantmind/quantflow/pull/83)).
77+
78+
[Full changelog](https://github.com/quantmind/quantflow/compare/v0.9.0...v1.0.0)
79+
980
## v0.9.0
1081

1182
Pricing-engine and calibration overhaul. `MaturityPricer` now evaluates call

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "quantflow"
3-
version = "0.9.0"
3+
version = "1.0.0"
44
description = "quantitative analysis"
55
authors = [
66
{ name = "Luca Sbardella", email = "luca@quantmind.com" },

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)