running-stats

Inspired by John D. Cook's blog

Add to your project

uv

To add running-stats to your project:

uv add running-stats

Usage

To compute running mean and variance, use RunningMeanVar. Numerical stable.

mean_var = RunningMeanVar()

for value in floats_from_somewhere():
    mean_var.push(value)
    # you can read values during iteration
    # print(mean_var.mean())
    # print(mean_var.variance())

# Let's print mean and variance of all values
print(mean_var.mean())
print(mean_var.variance())

You can also combine two RunningMeanVar:s.

mean_var1 = RunningMeanVar()

for value in floats_from_somewhere1():
    mean_var1.push(value)

mean_var2 = RunningMeanVar()

for value in floats_from_somewhere2():
    mean_var2.push(value)

combined = mean_var1 + mean_var2

# Let's print mean and variance of all values
print(combined.mean())
print(combined.variance())

Minimum Supported Python Version Policy

The Minimum Supported Python Version is fixed for a given minor (1.x) version. However it can be increased when bumping minor versions, i.e. going from 1.0 to 1.1 allows us to increase the Minimum Supported Python Version. Users unable to increase their Python version can use an older minor version instead. Below is a list of running-stats versions and their Minimum Supported Python Version:

• v0.2: Python 3.10.
• v0.1: Python 3.9.

Note however that running-stats also has dependencies, which might have different MSPV policies. We try to stick to the above policy when updating dependencies, but this is not always possible.

Changelog

This project keeps a changelog.

License

This repository is licensed under the MIT license.

Development

Development prerequisites

• uv
• pre-commit

For starting to develop on this repository:

• Clone the repo (in one of the ways below):
  • git clone git@github.com:spraakbanken/running-stats-py.git
  • git clone https://github.com/spraakbanken/running-stats-py.git
• Setup environment: make dev
• Install pre-commit hooks: pre-commit install

Do your work.

Tasks to do:

• Test the code with make test or make test-w-coverage.
• Lint the code with make lint.
• Check formatting with make check-fmt.
• Format the code with make fmt.
• Type-check the code with make type-check.

This repo uses conventional commits.

Release a new version

• Prepare the CHANGELOG: make prepare-release.
• Edit CHANGELOG.md to your liking.
• Add to git: git add --update
• Commit with git commit -m 'chore(release): prepare release' or cog commit chore 'prepare release' release.
• Bump version (depends on `bump-my-version)
  • Major: make bumpversion part=major
  • Minor: make bumpversion part=minor
  • Patch: make bumpversion part=patch or make bumpversion
• Push main and tags to GitHub: git push main --tags or make publish
  • GitHub Actions workflow will build, test and publish the package to PyPi.