Changelog¶
All notable changes to this project are documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning, written in PEP 440 notation. Before 1.0.0, a minor release may break the public API; such breaks are listed under Changed or Removed.
Changes to a method, its parameters or its reference vectors are listed explicitly, since they can change published results.
Unreleased¶
0.1.0 - 2026-11-19¶
First version that computes: the contract every method shares, the vote counts of the ordinal family, and co-clustering with the single-membership block model.
Changed¶
The service scaffold under
services/apifollows the engine: its version is 0.1.0 and it pinsciviqhub-selene==0.1.0. The version of its HTTP contract, inopenapi.yaml, is separate and stays at 0.0.1.The description of the package no longer says “not functional yet”.
Added¶
Core contract shared by every method, on the standard library alone: the
SeleneErrorhierarchy (errors), the provenance and result typesMethod,Randomness,Provenance,Result,Unavailable,StandardErrorandInterval(types), theEstimatorbase class whoseestimateis written once (estimator), theRegistryof estimators read from theciviqhub_selene.estimatorsentry points (registry), and the contract kitEstimatorContract(testing).ordinal.VoteCounts, the five vote counts of an item on the agreement scale, with exact shares.Optional extra
blocks(pip install "civiqhub-selene[blocks]"), which depends on NumPy 2.0 or later (BSD-3-Clause) and opens theciviqhub_selene.blockssubpackage for co-clustering. Without the extra, importingciviqhub_selene.blocksraisesMissingExtraError; the core andordinalstay on the standard library, which the newtest-coreCI job checks.Data of co-clustering in
civiqhub_selene.blocks:OrdinalScale,VoteMatrix(a vote matrix with three states per cell: voted, shown without a vote, not shown),PartitionwithVoterGroupandItemBlock,GroupedVotes,CoclusterandCoclusterTable, and the synthetic generatormake_voteswith its planted truth.Response models of the co-clusters: the
ResponseModelprotocol,Categorical(a free distribution over the scores) andOrdinalProbit(a latent normal opinion cut by fixed thresholds; Corneli, Bouveyron, Latouche 2020), with reference vectors undertests/vectors/blocks_numerics.json.Architecture of the block models:
IterativeEstimator(several starts, one seed per start, convergence, best start),CoclusteringEstimator,BlockModel, the plain-word lookupestimator_for, and the valuesCoclustering,SingleCoclustering,MixedCoclusteringandSelection. The mixed-membership model, the choice of shape and thecoclusterfunction come next.blocks.LatentBlockModel, the first block model: co-clustering where each voter belongs to one group and each item to one block, estimated by classification expectation-maximisation (Govaert and Nadif 2003), with the integrated completed likelihood of its value (Biernacki, Celeux and Govaert 2000). It is declared under the entry pointcoclustering.single, and a reference run on stored votes lives intests/vectors/latent_block_model.json.Property-based tests with Hypothesis, a test-only dependency.
docs/architecture.md: how the engine is built and how to add a method.Sources of a documentation site under
docs/, built with Sphinx: a getting-started page, a map of the library, and a reference generated from the docstrings, one page per public module. ThedocumentationCI job builds it with warnings as errors; the tests check that every public module has its page and that every Python block of the pages runs and prints the output shown.Publication of the documentation site on GitHub Pages, at https://civiqhub.github.io/civiqhub-selene/, by the
docsworkflow: one folder per version (the release thatmainholds, the earlier release tags, and the development branch), and a version selector on every page.
0.0.1 - 2026-10-25¶
Added¶
Repository scaffold:
civiqhub_selenepackage with reservedordinal,semanticandlandscapenamespaces and a documentedtypescontract, without any computation.Service scaffold under
services/api: documented stubs, OpenAPI shell and commented Dockerfile.Test layout: unit, property-based, contract and reference-vector suites.
Apache-2.0 license, NOTICE, governance, contribution and security policies, citation metadata.
CI workflow (lint, type checking, tests, build, clean install, DCO) and release workflow publishing to PyPI through Trusted Publishing.