-
Notifications
You must be signed in to change notification settings - Fork 0
feat(method): refuse corpus-background wording as unique content #151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
3338e81
feat(method): refuse corpus-background wording as unique content
seonghobae 32b9ff5
Merge remote-tracking branch 'origin/main' into review/pr151-current
seonghobae c7d5ed2
test: derive crate contract from workspace manifest
seonghobae a35d329
docs: remove duplicate provider payload ledger row
seonghobae f87c812
Merge current main into corpus background gate
seonghobae 0dedd82
Merge remote-tracking branch 'origin/main' into agent/corpus-background
seonghobae 6a6ce94
chore: regenerate Cargo.lock after main merge
seonghobae File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| [package] | ||
| name = "corpus_background" | ||
| description = "Corpus-background wording 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| //! Fail-closed corpus-background errors. | ||
|
|
||
| use std::fmt; | ||
|
|
||
| /// A fail-closed corpus-background error. | ||
| #[derive(Clone, Copy, Debug, Eq, PartialEq)] | ||
| #[non_exhaustive] | ||
| pub enum CorpusBackgroundError { | ||
| /// Corpus-background wording was treated as unique latent content. | ||
| CorpusBackgroundIsNotUniqueContent, | ||
| /// Corpus-background wording was treated as stopword deletion. | ||
| CorpusBackgroundIsNotStopwordDeletion, | ||
| /// A recovery slice was empty or length-mismatched. | ||
| InvalidCorpusBackgroundPayload, | ||
| } | ||
|
|
||
| impl fmt::Display for CorpusBackgroundError { | ||
| fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| let message = match self { | ||
| Self::CorpusBackgroundIsNotUniqueContent => { | ||
| "corpus-background wording is not unique latent content" | ||
| } | ||
| Self::CorpusBackgroundIsNotStopwordDeletion => { | ||
| "corpus-background wording is not stopword deletion" | ||
| } | ||
| Self::InvalidCorpusBackgroundPayload => "invalid corpus-background payload", | ||
| }; | ||
| formatter.write_str(message) | ||
| } | ||
| } | ||
|
|
||
| impl std::error::Error for CorpusBackgroundError {} | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::CorpusBackgroundError; | ||
|
|
||
| #[test] | ||
| fn error_messages_are_stable() { | ||
| for (error, message) in [ | ||
| ( | ||
| CorpusBackgroundError::CorpusBackgroundIsNotUniqueContent, | ||
| "corpus-background wording is not unique latent content", | ||
| ), | ||
| ( | ||
| CorpusBackgroundError::CorpusBackgroundIsNotStopwordDeletion, | ||
| "corpus-background wording is not stopword deletion", | ||
| ), | ||
| ( | ||
| CorpusBackgroundError::InvalidCorpusBackgroundPayload, | ||
| "invalid corpus-background payload", | ||
| ), | ||
| ] { | ||
| assert_eq!(error.to_string(), message); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| //! Corpus-background wording versus unique latent content. | ||
|
|
||
| use crate::CorpusBackgroundError; | ||
|
|
||
| /// Closed vocabulary of corpus-background token treatments. | ||
| #[derive(Clone, Copy, Debug, Eq, PartialEq)] | ||
| pub enum CorpusBackgroundKind { | ||
| /// Corpus-level background language, not unique document meaning. | ||
| CorpusBackground, | ||
| /// Token treatment reserved for unique latent content. | ||
| UniqueContent, | ||
| } | ||
|
|
||
| impl CorpusBackgroundKind { | ||
| /// Return the stable wire kind name. | ||
| #[must_use] | ||
| pub const fn wire_name(self) -> &'static str { | ||
| match self { | ||
| Self::CorpusBackground => "corpus_background", | ||
| Self::UniqueContent => "unique_content", | ||
| } | ||
| } | ||
|
|
||
| /// Parse a stable wire kind name. | ||
| /// | ||
| /// # Errors | ||
| /// | ||
| /// Returns [`CorpusBackgroundError::InvalidCorpusBackgroundPayload`] for | ||
| /// unrecognized names. | ||
| pub fn from_wire_name(name: &str) -> Result<Self, CorpusBackgroundError> { | ||
| match name { | ||
| "corpus_background" => Ok(Self::CorpusBackground), | ||
| "unique_content" => Ok(Self::UniqueContent), | ||
| _ => Err(CorpusBackgroundError::InvalidCorpusBackgroundPayload), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Refuse to treat corpus-background wording as unique latent content. | ||
| /// | ||
| /// # Errors | ||
| /// | ||
| /// Returns [`CorpusBackgroundError::CorpusBackgroundIsNotUniqueContent`] when | ||
| /// `kind` is [`CorpusBackgroundKind::CorpusBackground`]. | ||
| pub fn refuse_corpus_background_as_unique_content( | ||
| kind: CorpusBackgroundKind, | ||
| ) -> Result<(), CorpusBackgroundError> { | ||
| match kind { | ||
| CorpusBackgroundKind::CorpusBackground => { | ||
| Err(CorpusBackgroundError::CorpusBackgroundIsNotUniqueContent) | ||
| } | ||
| CorpusBackgroundKind::UniqueContent => Ok(()), | ||
| } | ||
| } | ||
|
|
||
| /// Refuse to treat corpus-background wording as stopword deletion. | ||
| /// | ||
| /// # Errors | ||
| /// | ||
| /// Returns [`CorpusBackgroundError::CorpusBackgroundIsNotStopwordDeletion`] | ||
| /// when `kind` is [`CorpusBackgroundKind::CorpusBackground`]. | ||
| pub fn refuse_corpus_background_as_stopword_deletion( | ||
| kind: CorpusBackgroundKind, | ||
| ) -> Result<(), CorpusBackgroundError> { | ||
| match kind { | ||
| CorpusBackgroundKind::CorpusBackground => { | ||
| Err(CorpusBackgroundError::CorpusBackgroundIsNotStopwordDeletion) | ||
| } | ||
| CorpusBackgroundKind::UniqueContent => Ok(()), | ||
| } | ||
| } | ||
|
|
||
| /// Fraction of recovered corpus-background kinds that match known truth. | ||
| /// | ||
| /// # Errors | ||
| /// | ||
| /// Returns [`CorpusBackgroundError::InvalidCorpusBackgroundPayload`] when | ||
| /// either slice is empty or the lengths differ. | ||
| pub fn identity_recovery_rate( | ||
| truth: &[CorpusBackgroundKind], | ||
| decided: &[CorpusBackgroundKind], | ||
| ) -> Result<f64, CorpusBackgroundError> { | ||
| if truth.is_empty() || truth.len() != decided.len() { | ||
| return Err(CorpusBackgroundError::InvalidCorpusBackgroundPayload); | ||
| } | ||
| 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) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::{ | ||
| CorpusBackgroundKind, identity_recovery_rate, | ||
| refuse_corpus_background_as_stopword_deletion, refuse_corpus_background_as_unique_content, | ||
| }; | ||
| use crate::CorpusBackgroundError; | ||
|
|
||
| #[test] | ||
| fn local_branches_cover_kinds_payloads_and_wire_names() { | ||
| assert_eq!( | ||
| refuse_corpus_background_as_unique_content(CorpusBackgroundKind::CorpusBackground), | ||
| Err(CorpusBackgroundError::CorpusBackgroundIsNotUniqueContent) | ||
| ); | ||
| assert_eq!( | ||
| refuse_corpus_background_as_stopword_deletion(CorpusBackgroundKind::CorpusBackground), | ||
| Err(CorpusBackgroundError::CorpusBackgroundIsNotStopwordDeletion) | ||
| ); | ||
| refuse_corpus_background_as_unique_content(CorpusBackgroundKind::UniqueContent) | ||
| .expect("unique"); | ||
| refuse_corpus_background_as_stopword_deletion(CorpusBackgroundKind::UniqueContent) | ||
| .expect("unique"); | ||
| for kind in [ | ||
| CorpusBackgroundKind::CorpusBackground, | ||
| CorpusBackgroundKind::UniqueContent, | ||
| ] { | ||
| assert_eq!( | ||
| CorpusBackgroundKind::from_wire_name(kind.wire_name()).expect("round-trip"), | ||
| kind | ||
| ); | ||
| } | ||
| assert_eq!( | ||
| CorpusBackgroundKind::from_wire_name("stopword"), | ||
| Err(CorpusBackgroundError::InvalidCorpusBackgroundPayload) | ||
| ); | ||
| let matched = identity_recovery_rate( | ||
| &[CorpusBackgroundKind::CorpusBackground], | ||
| &[CorpusBackgroundKind::CorpusBackground], | ||
| ) | ||
| .expect("rate"); | ||
| assert!((matched - 1.0).abs() < f64::EPSILON); | ||
| assert_eq!( | ||
| identity_recovery_rate(&[], &[]), | ||
| Err(CorpusBackgroundError::InvalidCorpusBackgroundPayload) | ||
| ); | ||
| assert_eq!( | ||
| identity_recovery_rate(&[CorpusBackgroundKind::CorpusBackground], &[]), | ||
| Err(CorpusBackgroundError::InvalidCorpusBackgroundPayload) | ||
| ); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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)] | ||
| //! Corpus-background wording is not unique latent content. | ||
| //! | ||
| //! Corpus-level background language stays explicit method/background | ||
| //! structure. It is not unique document meaning and is not erased by a | ||
| //! stopword list (ADR 0004/0012). | ||
|
|
||
| mod error; | ||
| mod kind; | ||
|
|
||
| /// Fail-closed corpus-background errors. | ||
| pub use error::CorpusBackgroundError; | ||
| /// Closed vocabulary of corpus-background token treatments. | ||
| pub use kind::CorpusBackgroundKind; | ||
| /// Fraction of recovered corpus-background kinds that match known truth. | ||
| pub use kind::identity_recovery_rate; | ||
| /// Refuse to treat corpus-background wording as stopword deletion. | ||
| pub use kind::refuse_corpus_background_as_stopword_deletion; | ||
| /// Refuse to treat corpus-background wording as unique latent content. | ||
| pub use kind::refuse_corpus_background_as_unique_content; |
72 changes: 72 additions & 0 deletions
72
crates/corpus_background/tests/corpus_background_contract.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| //! Corpus-background wording is not unique content and not stopword deletion. | ||
|
|
||
| use corpus_background::{ | ||
| CorpusBackgroundError, CorpusBackgroundKind, identity_recovery_rate, | ||
| refuse_corpus_background_as_stopword_deletion, refuse_corpus_background_as_unique_content, | ||
| }; | ||
|
|
||
| #[test] | ||
| fn corpus_background_cannot_become_unique_content_or_stopword_deletion() { | ||
| assert_eq!( | ||
| refuse_corpus_background_as_unique_content(CorpusBackgroundKind::CorpusBackground), | ||
| Err(CorpusBackgroundError::CorpusBackgroundIsNotUniqueContent) | ||
| ); | ||
| assert_eq!( | ||
| refuse_corpus_background_as_stopword_deletion(CorpusBackgroundKind::CorpusBackground), | ||
| Err(CorpusBackgroundError::CorpusBackgroundIsNotStopwordDeletion) | ||
| ); | ||
| refuse_corpus_background_as_unique_content(CorpusBackgroundKind::UniqueContent) | ||
| .expect("unique"); | ||
| refuse_corpus_background_as_stopword_deletion(CorpusBackgroundKind::UniqueContent) | ||
| .expect("unique"); | ||
| } | ||
|
|
||
| #[test] | ||
| fn recovered_kinds_match_known_truth_better_than_a_unique_content_collapse() { | ||
| let truth = [ | ||
| CorpusBackgroundKind::CorpusBackground, | ||
| CorpusBackgroundKind::UniqueContent, | ||
| CorpusBackgroundKind::CorpusBackground, | ||
| ]; | ||
| let recovered = truth; | ||
| let collapsed = [ | ||
| CorpusBackgroundKind::UniqueContent, | ||
| CorpusBackgroundKind::UniqueContent, | ||
| CorpusBackgroundKind::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(CorpusBackgroundError::InvalidCorpusBackgroundPayload) | ||
| ); | ||
| assert_eq!( | ||
| identity_recovery_rate(&[CorpusBackgroundKind::CorpusBackground], &[]), | ||
| Err(CorpusBackgroundError::InvalidCorpusBackgroundPayload) | ||
| ); | ||
| assert_eq!( | ||
| identity_recovery_rate( | ||
| &[ | ||
| CorpusBackgroundKind::CorpusBackground, | ||
| CorpusBackgroundKind::UniqueContent | ||
| ], | ||
| &[CorpusBackgroundKind::CorpusBackground] | ||
| ), | ||
| Err(CorpusBackgroundError::InvalidCorpusBackgroundPayload) | ||
| ); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| //! Integration contract for the `corpus_background` package identity. | ||
|
|
||
| #[test] | ||
| fn package_identity_is_stable() { | ||
| let observed = std::hint::black_box(env!("CARGO_PKG_NAME")); | ||
| assert_eq!(observed, "corpus_background"); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 logic and casts are correct
kind.rs guards against empty and length-mismatched slices before computing the match fraction, and
matchesis bounded bytruth.len(), so thef64::from(matches) / truth.len() as f64division cannot divide by zero and is not affected by thecast_precision_lossallow beyond acceptable precision for realistic corpus sizes. No bug here.Was this helpful? React with 👍 or 👎 to provide feedback.