feat: add remote synthetic corpus support and paper-style docs#5
Merged
feat: add remote synthetic corpus support and paper-style docs#5
Conversation
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #5 +/- ##
===========================================
- Coverage 48.86% 37.08% -11.78%
===========================================
Files 9 13 +4
Lines 395 728 +333
Branches 70 127 +57
===========================================
+ Hits 193 270 +77
- Misses 171 403 +232
- Partials 31 55 +24
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request updates the documentation for Maxwell-Demon, shifting from informal guides to a more formal, English-language specification of the methodology, operational protocol, and theoretical framework. The changes clarify the dual-reference classification approach, provide a step-by-step execution protocol, and formalize the mathematical/statistical basis for distinguishing human and synthetic text. The documentation is now more accessible for non-Italian speakers and better structured for reproducible research.
Documentation modernization and clarity:
DOC/README.md: Rewrote the overview in English, clarified the contents and purpose of each documentation file, and emphasized the formal nature of the technical documentation.DOC/guide.md: Replaced the informal Italian-centric workflow with a formalized operational protocol, specifying reproducibility preconditions, dataset validation, reference calibration, tournament inference, phase-space analysis, and interpretation heuristics. Added explicit commands, acceptance criteria, and minimal execution traces.Formalization of theoretical framework:
DOC/theoretical_framework.md: Reorganized and formalized the mathematical/statistical basis for the dual-reference method. Defined the problem, dual-reference hypothesis, tournament mechanics, differential entropy statistic, interpretation regime, burstiness descriptor, phase-space geometry, and validity constraints. Provided explicit equations and clarified the operational meaning of key metrics (delta_h,burstiness_paisa).