Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ boundaries above remain the target modular MSA architecture.
| `tepp_simulation` | known-truth temporal/event data generation |
| `validation_core` | RMSE, bias, coverage, graph, and Monte Carlo metrics |
| `tepp_api` | versioned DTO, schema, and export contracts |
| `modality_source` | non-lexical modality is not unique latent content and not stopword deletion |
| `copied_text` | copied-text residue is not unique latent content and not stopword deletion |
| `style_source` | house-voice style residue is not unique latent content and not stopword deletion |
| `stopword_deletion` | default stopword deletion is not a valid method for repeated report language |
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Info: Historical changelog line still says 'ten' crates

CHANGELOG.md still reads "Rust 1.97.1 virtual Cargo workspace with ten explicit modular foundation crates." while README.md was updated to "eleven". This CHANGELOG line is a historical Task-1 Added entry describing the original ten-crate foundation, so leaving it unchanged is arguably faithful to what was originally added rather than a defect. No test or contract script asserts a crate count against this text, so it does not break CI. Flagging only for editorial consistency consideration.

(Refers to this code)

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ All notable changes to TEPP are documented here. The format follows Keep a Chang

### Added

- `modality_source` identity gate: non-lexical modality is not unique latent content and is not erased by a stopword list; recovered modality kinds match known truth at a higher computed rate than collapsing every token to unique content (ADR 0004/0012).
- `copied_text` identity gate: copied and boilerplate residue is not unique latent content and is not erased by a stopword list; recovered copied-text kinds match known truth at a higher computed rate than collapsing every token to unique content (ADR 0004/0012).
- `style_source` identity gate: house-voice style residue is not unique latent content and is not erased by a stopword list; recovered style kinds match known truth at a higher computed rate than collapsing every token to unique content (ADR 0004/0012).
- `stopword_deletion` method gate: a default or global stopword list cannot erase repeated report language; recovered deletion kinds match known truth at a higher computed rate than collapsing every token treatment to stopword deletion (ADR 0004/0012).
Expand Down
4 changes: 4 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ members = [
"crates/tepp_simulation",
"crates/validation_core",
"crates/tepp_api",
"crates/modality_source",
"crates/copied_text",
"crates/style_source",
"crates/stopword_deletion",
Expand Down Expand Up @@ -57,6 +58,7 @@ default-members = [
"crates/tepp_simulation",
"crates/validation_core",
"crates/tepp_api",
"crates/modality_source",
"crates/copied_text",
"crates/style_source",
"crates/stopword_deletion",
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ crates/corpus_split
crates/tepp_simulation
crates/validation_core
crates/tepp_api
crates/modality_source
crates/copied_text
crates/style_source
crates/stopword_deletion
Expand Down
17 changes: 17 additions & 0 deletions crates/modality_source/Cargo.toml

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Info: New crate satisfies workspace contract checks

The new modality_source crate meets every requirement enforced by check_workspace_contract.py: Cargo.toml sets publish = false, [lints] workspace = true, and inherits all required package fields; lib.rs has crate-level //! rustdoc, #![forbid(unsafe_code)], and #![deny(missing_docs)] with no placeholder API; and crate_contract.rs provides the required package-identity contract test. EXPECTED_CRATES and both members/default-members lists were updated consistently, and README's crate count was updated from ten to eleven.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[package]
name = "modality_source"
description = "Non-lexical modality is not unique content and not stopword deletion."
version.workspace = true
edition.workspace = true
rust-version.workspace = true
license.workspace = true
authors.workspace = true
repository.workspace = true
homepage.workspace = true
readme.workspace = true
keywords.workspace = true
categories.workspace = true
publish = false

[lints]
workspace = true
53 changes: 53 additions & 0 deletions crates/modality_source/src/error.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
//! Fail-closed modality-source errors.

use std::fmt;

/// A fail-closed modality-source error.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum ModalitySourceError {
/// Non-lexical modality was treated as unique latent content.
ModalityIsNotUniqueContent,
/// Non-lexical modality was treated as stopword deletion.
ModalityIsNotStopwordDeletion,
/// A recovery slice was empty or length-mismatched.
InvalidModalityPayload,
}

impl fmt::Display for ModalitySourceError {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
let message = match self {
Self::ModalityIsNotUniqueContent => "non-lexical modality is not unique latent content",
Self::ModalityIsNotStopwordDeletion => "non-lexical modality is not stopword deletion",
Self::InvalidModalityPayload => "invalid modality-source payload",
};
formatter.write_str(message)
}
}

impl std::error::Error for ModalitySourceError {}

#[cfg(test)]
mod tests {
use super::ModalitySourceError;

#[test]
fn error_messages_are_stable() {
for (error, message) in [
(
ModalitySourceError::ModalityIsNotUniqueContent,
"non-lexical modality is not unique latent content",
),
(
ModalitySourceError::ModalityIsNotStopwordDeletion,
"non-lexical modality is not stopword deletion",
),
(
ModalitySourceError::InvalidModalityPayload,
"invalid modality-source payload",
),
] {
assert_eq!(error.to_string(), message);
}
}
}
135 changes: 135 additions & 0 deletions crates/modality_source/src/kind.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
//! Non-lexical modality versus unique latent content.

use crate::ModalitySourceError;

/// Closed vocabulary of modality-related token treatments.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ModalityKind {
/// Non-lexical modality channel, not unique document meaning.
NonLexicalModality,
/// Token treatment reserved for unique latent content.
UniqueContent,
}

impl ModalityKind {
/// Return the stable wire kind name.
#[must_use]
pub const fn wire_name(self) -> &'static str {
match self {
Self::NonLexicalModality => "modality",
Self::UniqueContent => "unique_content",
}
}

/// Parse a stable wire kind name.
///
/// # Errors
///
/// Returns [`ModalitySourceError::InvalidModalityPayload`] for unrecognized
/// names.
pub fn from_wire_name(name: &str) -> Result<Self, ModalitySourceError> {
match name {
"modality" => Ok(Self::NonLexicalModality),
"unique_content" => Ok(Self::UniqueContent),
_ => Err(ModalitySourceError::InvalidModalityPayload),
}
}
}

/// Refuse to treat non-lexical modality as unique latent content.
///
/// # Errors
///
/// Returns [`ModalitySourceError::ModalityIsNotUniqueContent`] when `kind` is
/// [`ModalityKind::NonLexicalModality`].
pub fn refuse_modality_as_unique_content(kind: ModalityKind) -> Result<(), ModalitySourceError> {
match kind {
ModalityKind::NonLexicalModality => Err(ModalitySourceError::ModalityIsNotUniqueContent),
ModalityKind::UniqueContent => Ok(()),
}
}

/// Refuse to treat non-lexical modality as stopword deletion.
///
/// # Errors
///
/// Returns [`ModalitySourceError::ModalityIsNotStopwordDeletion`] when `kind`
/// is [`ModalityKind::NonLexicalModality`].
pub fn refuse_modality_as_stopword_deletion(kind: ModalityKind) -> Result<(), ModalitySourceError> {
match kind {
ModalityKind::NonLexicalModality => Err(ModalitySourceError::ModalityIsNotStopwordDeletion),
ModalityKind::UniqueContent => Ok(()),
}
}

/// Fraction of recovered modality kinds that match known truth.
///
/// # Errors
///
/// Returns [`ModalitySourceError::InvalidModalityPayload`] when either slice
/// is empty or the lengths differ.
pub fn identity_recovery_rate(
truth: &[ModalityKind],
decided: &[ModalityKind],
) -> Result<f64, ModalitySourceError> {
if truth.is_empty() || truth.len() != decided.len() {
return Err(ModalitySourceError::InvalidModalityPayload);
}
let mut matches = 0_u32;
for (truth_kind, decided_kind) in truth.iter().zip(decided) {
if truth_kind == decided_kind {
matches += 1;
}
}
Ok(f64::from(matches) / truth.len() as f64)
Comment on lines +78 to +84

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Info: Branch coverage relies on integration tests, not unit tests alone

The 100% branch-coverage contract (AGENTS.md #8) requires both branches of if truth_kind == decided_kind in kind.rs to be exercised. The in-module unit test only ever passes matching pairs, so the mismatch (false) branch is only covered by the integration test recovered_kinds_match_known_truth_better_than_a_unique_content_collapse in modality_source_contract.rs, which supplies collapsed values. Coverage therefore depends on cargo llvm-cov including integration test targets; if the coverage run scopes to lib-only, this branch would appear uncovered. Not a bug given the standard workspace coverage config, but worth noting the dependency.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

}
Comment on lines +71 to +85

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Info: identity_recovery_rate fail-closed and arithmetic verified

identity_recovery_rate at kind.rs correctly fails closed for empty or length-mismatched slices before any division, and the match count divided by truth.len() cannot divide by zero due to the earlier empty check. The #![allow(clippy::cast_precision_loss)] in lib.rs is what permits the as f64 cast on the length. Logic is sound.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


#[cfg(test)]
mod tests {
use super::{
ModalityKind, identity_recovery_rate, refuse_modality_as_stopword_deletion,
refuse_modality_as_unique_content,
};
use crate::ModalitySourceError;

#[test]
fn local_branches_cover_kinds_payloads_and_wire_names() {
assert_eq!(
refuse_modality_as_unique_content(ModalityKind::NonLexicalModality),
Err(ModalitySourceError::ModalityIsNotUniqueContent)
);
assert_eq!(
refuse_modality_as_stopword_deletion(ModalityKind::NonLexicalModality),
Err(ModalitySourceError::ModalityIsNotStopwordDeletion)
);
refuse_modality_as_unique_content(ModalityKind::UniqueContent).expect("unique");
refuse_modality_as_stopword_deletion(ModalityKind::UniqueContent).expect("unique");
for kind in [
ModalityKind::NonLexicalModality,
ModalityKind::UniqueContent,
] {
assert_eq!(
ModalityKind::from_wire_name(kind.wire_name()).expect("round-trip"),
kind
);
}
assert_eq!(
ModalityKind::from_wire_name("stopword"),
Err(ModalitySourceError::InvalidModalityPayload)
);
let matched = identity_recovery_rate(
&[ModalityKind::NonLexicalModality],
&[ModalityKind::NonLexicalModality],
)
.expect("rate");
assert!((matched - 1.0).abs() < f64::EPSILON);
assert_eq!(
identity_recovery_rate(&[], &[]),
Err(ModalitySourceError::InvalidModalityPayload)
);
assert_eq!(
identity_recovery_rate(&[ModalityKind::NonLexicalModality], &[]),
Err(ModalitySourceError::InvalidModalityPayload)
);
}
}
22 changes: 22 additions & 0 deletions crates/modality_source/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#![forbid(unsafe_code)]
#![deny(missing_docs)]
#![allow(clippy::cast_precision_loss)]
//! Non-lexical modality is not unique latent content.
//!
//! Modality channels stay explicit method/background structure. They are
//! not unique document meaning and are not erased by a stopword list
//! (ADR 0004/0012).

mod error;
mod kind;

/// Fail-closed modality-source errors.
pub use error::ModalitySourceError;
/// Closed vocabulary of modality-related token treatments.
pub use kind::ModalityKind;
/// Fraction of recovered modality kinds that match known truth.
pub use kind::identity_recovery_rate;
/// Refuse to treat non-lexical modality as stopword deletion.
pub use kind::refuse_modality_as_stopword_deletion;
/// Refuse to treat non-lexical modality as unique latent content.
pub use kind::refuse_modality_as_unique_content;
7 changes: 7 additions & 0 deletions crates/modality_source/tests/crate_contract.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
//! Integration contract for the `modality_source` package identity.

#[test]
fn package_identity_is_stable() {
let observed = std::hint::black_box(env!("CARGO_PKG_NAME"));
assert_eq!(observed, "modality_source");
}
70 changes: 70 additions & 0 deletions crates/modality_source/tests/modality_source_contract.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
//! Non-lexical modality is not unique content and not stopword deletion.

use modality_source::{
ModalityKind, ModalitySourceError, identity_recovery_rate,
refuse_modality_as_stopword_deletion, refuse_modality_as_unique_content,
};

#[test]
fn non_lexical_modality_cannot_become_unique_content_or_stopword_deletion() {
assert_eq!(
refuse_modality_as_unique_content(ModalityKind::NonLexicalModality),
Err(ModalitySourceError::ModalityIsNotUniqueContent)
);
assert_eq!(
refuse_modality_as_stopword_deletion(ModalityKind::NonLexicalModality),
Err(ModalitySourceError::ModalityIsNotStopwordDeletion)
);
refuse_modality_as_unique_content(ModalityKind::UniqueContent).expect("unique");
refuse_modality_as_stopword_deletion(ModalityKind::UniqueContent).expect("unique");
}

#[test]
fn recovered_kinds_match_known_truth_better_than_a_unique_content_collapse() {
let truth = [
ModalityKind::NonLexicalModality,
ModalityKind::UniqueContent,
ModalityKind::NonLexicalModality,
];
let recovered = truth;
let collapsed = [
ModalityKind::UniqueContent,
ModalityKind::UniqueContent,
ModalityKind::UniqueContent,
];
let recovered_rate = identity_recovery_rate(&truth, &recovered).expect("recovered");
let collapsed_rate = identity_recovery_rate(&truth, &collapsed).expect("collapsed");
let expected = {
let mut matches = 0_u32;
for (truth_kind, decided_kind) in truth.iter().zip(recovered.iter()) {
if truth_kind == decided_kind {
matches += 1;
}
}
f64::from(matches) / f64::from(u32::try_from(truth.len()).expect("len"))
};
assert!((recovered_rate - expected).abs() < f64::EPSILON);
assert!(recovered_rate > collapsed_rate);
}

#[test]
fn empty_or_mismatched_kind_payloads_fail_closed() {
assert_eq!(
identity_recovery_rate(&[], &[]),
Err(ModalitySourceError::InvalidModalityPayload)
);
assert_eq!(
identity_recovery_rate(&[ModalityKind::NonLexicalModality], &[]),
Err(ModalitySourceError::InvalidModalityPayload)
);
assert_eq!(
identity_recovery_rate(
&[
ModalityKind::NonLexicalModality,
ModalityKind::UniqueContent
],
&[ModalityKind::NonLexicalModality]
),
Err(ModalitySourceError::InvalidModalityPayload)
);
}
2 changes: 1 addition & 1 deletion docs/TRACEABILITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The full APA 7th standards/literature register remains `docs/research/standards-
| TRSL-TM temporal/relational topic posterior and backend compatibility | ADR 0012; ADR 0004 | future `topic_measurement` | accepted-target |
| global P0 topic identity with activity/dormancy/reactivation | ADR 0012 | future topic lineage/activity state | accepted-target |
| no default stopword deletion / no TF-IDF-BM25 inferential weighting | ADR 0004/0012; PRD/TRD | future semantic/method-source model | accepted-target |
| report template/section/copied/style/modality method effects | ADR 0004/0012; PRD/TRD | simulation truth factors implemented; `copied_text` copied-versus-unique-content identity on the active PR; estimator-side method model remains future | partial |
| report template/section/copied/style/modality method effects | ADR 0004/0012; PRD/TRD | simulation truth factors implemented; `modality_source` modality-versus-unique-content identity on the active PR; estimator-side method model remains future | partial |
| candidate K statistical/Pareto gates + blinded LLM review | ADR 0012; research | future `model_selection` | accepted-target |
| compositional topic correlation / stable clustering | ADR 0005/0012; research | future `network_analysis` | accepted-target |
| posterior ESEM / longitudinal invariance / DSEM | ADR 0005 | `psychometric_fit` ESEM loading and DSEM lag gates on the active PR; `psychometric_core` input gates remain #49; invariance/multilevel remain accepted-target | active-PR |
Expand Down
1 change: 1 addition & 0 deletions docs/adr/0004-shared-multilingual-latent-space.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# ADR 0004 — Shared multilingual latent semantic space

**Decision status:** Accepted
**Implementation maturity:** accepted-target — modality-versus-unique-content identity in `modality_source` on the active PR; shared-space estimators remain accepted-target
**Implementation maturity:** accepted-target — copied-versus-unique-content identity in `copied_text` on the active PR; shared-space estimators remain accepted-target
**Implementation maturity:** accepted-target — style-versus-unique-content identity in `style_source` on the active PR; shared-space estimators remain accepted-target
**Implementation maturity:** partial — default stopword-deletion refusal is `stopword_deletion` on the active PR; shared-space estimators, language profiles, and TF-IDF/BM25 inferential-weight refusal remain accepted-target
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# ADR 0012 — Temporal Relational Shared-Latent Topic Measurement

**Decision status:** Accepted
**Implementation maturity:** accepted-target — modality-versus-unique-content identity in `modality_source` on the active PR; estimator-side method model remains accepted-target
**Implementation maturity:** accepted-target — copied-versus-unique-content identity in `copied_text` on the active PR; estimator-side method model remains accepted-target
**Implementation maturity:** accepted-target — style-versus-unique-content identity in `style_source` on the active PR; estimator-side method model remains accepted-target
**Implementation maturity:** partial — default stopword-deletion refusal is `stopword_deletion` on the active PR; topic estimator, global topic identity, method-effect model, and TF-IDF/BM25 inferential-weight refusal remain accepted-target
Expand Down
Loading
Loading