keybridge 1.0.0__tar.gz

keybridge-1.0.0/LICENSE

@@ -0,0 +1,28 @@
+MIT License
+
+Copyright (c) 2026 Micaella Bruton, Meriem Beloucif, Beáta Megyesi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+This MIT licence covers the source code: src/keybridge/*.py, tools/ and notebooks/.
+Trained models, keys, language profiles (src/keybridge/language_profiles/) and
+documentation (docs/, README.md, examples/) are licensed under CC BY 4.0; see
+LICENSE-CC-BY-4.0.txt.

keybridge-1.0.0/LICENSE-CC-BY-4.0.txt

@@ -0,0 +1,415 @@
+Copyright (c) 2026 Micaella Bruton, Meriem Beloucif, Beáta Megyesi
+
+The following are licensed under the Creative Commons Attribution 4.0 International
+License (CC BY 4.0):
+  - trained models and their index (the Hugging Face model collection),
+  - keys in examples/ and in the model collection,
+  - language profiles in src/keybridge/language_profiles/,
+  - documentation: README.md and docs/.
+
+You are free to share and adapt them for any purpose, even commercially, provided that you
+give appropriate credit (please cite the publication given in CITATION.cff), provide a link
+to the licence, and indicate if changes were made.
+
+Licence summary: https://creativecommons.org/licenses/by/4.0/
+Full legal code: https://creativecommons.org/licenses/by/4.0/legalcode
+
+=======================================================================
+Full legal code
+=======================================================================
+
+Attribution 4.0 International
+
+=======================================================================
+
+Creative Commons Corporation ("Creative Commons") is not a law firm and
+does not provide legal services or legal advice. Distribution of
+Creative Commons public licenses does not create a lawyer-client or
+other relationship. Creative Commons makes its licenses and related
+information available on an "as-is" basis. Creative Commons gives no
+warranties regarding its licenses, any material licensed under their
+terms and conditions, or any related information. Creative Commons
+disclaims all liability for damages resulting from their use to the
+fullest extent possible.
+
+Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and
+conditions that creators and other rights holders may use to share
+original works of authorship and other material subject to copyright
+and certain other rights specified in the public license below. The
+following considerations are for informational purposes only, are not
+exhaustive, and do not form part of our licenses.
+
+     Considerations for licensors: Our public licenses are
+     intended for use by those authorized to give the public
+     permission to use material in ways otherwise restricted by
+     copyright and certain other rights. Our licenses are
+     irrevocable. Licensors should read and understand the terms
+     and conditions of the license they choose before applying it.
+     Licensors should also secure all rights necessary before
+     applying our licenses so that the public can reuse the
+     material as expected. Licensors should clearly mark any
+     material not subject to the license. This includes other CC-
+     licensed material, or material used under an exception or
+     limitation to copyright. More considerations for licensors:
+    wiki.creativecommons.org/Considerations_for_licensors
+
+     Considerations for the public: By using one of our public
+     licenses, a licensor grants the public permission to use the
+     licensed material under specified terms and conditions. If
+     the licensor's permission is not necessary for any reason--for
+     example, because of any applicable exception or limitation to
+     copyright--then that use is not regulated by the license. Our
+     licenses grant only permissions under copyright and certain
+     other rights that a licensor has authority to grant. Use of
+     the licensed material may still be restricted for other
+     reasons, including because others have copyright or other
+     rights in the material. A licensor may make special requests,
+     such as asking that all changes be marked or described.
+     Although not required by our licenses, you are encouraged to
+     respect those requests where reasonable. More considerations
+     for the public:
+    wiki.creativecommons.org/Considerations_for_licensees
+
+=======================================================================
+
+Creative Commons Attribution 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution 4.0 International Public License ("Public License"). To the
+extent this Public License may be interpreted as a contract, You are
+granted the Licensed Rights in consideration of Your acceptance of
+these terms and conditions, and the Licensor grants You such rights in
+consideration of benefits the Licensor receives from making the
+Licensed Material available under these terms and conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+
+  d. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  e. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  f. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  g. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  h. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  i. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  j. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  k. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part; and
+
+            b. produce, reproduce, and Share Adapted Material.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+       4. If You Share Adapted Material You produce, the Adapter's
+          License You apply must not prevent recipients of the Adapted
+          Material from complying with this Public License.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material; and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.
+
+
+=======================================================================
+
+Creative Commons is not a party to its public
+licenses. Notwithstanding, Creative Commons may elect to apply one of
+its public licenses to material it publishes and in those instances
+will be considered the “Licensor.” The text of the Creative Commons
+public licenses is dedicated to the public domain under the CC0 Public
+Domain Dedication. Except for the limited purpose of indicating that
+material is shared under a Creative Commons public license or as
+otherwise permitted by the Creative Commons policies published at
+creativecommons.org/policies, Creative Commons does not authorize the
+use of the trademark "Creative Commons" or any other trademark or logo
+of Creative Commons without its prior written consent including,
+without limitation, in connection with any unauthorized modifications
+to any of its public licenses or any other arrangements,
+understandings, or agreements concerning use of licensed material. For
+the avoidance of doubt, this paragraph does not form part of the
+public licenses.
+
+Creative Commons may be contacted at creativecommons.org.

keybridge-1.0.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: keybridge
+Version: 1.0.0
+Summary: Shared-space neural decipherment of historical simple and homophonic substitution ciphers
+Author: Micaella Bruton, Meriem Beloucif, Beáta Megyesi
+License: MIT
+Project-URL: Homepage, https://github.com/mbruton0426/keybridge
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE-CC-BY-4.0.txt
+Requires-Dist: torch>=2.1
+Requires-Dist: scikit-learn>=1.0
+Requires-Dist: huggingface_hub>=0.20
+Requires-Dist: datasets>=2.14
+Requires-Dist: optuna>=3.0
+Provides-Extra: search
+Dynamic: license-file
+
+# keybridge: neural decipherment of historical simple and homophonic substitution ciphers
+
+Archives hold many cipher keys whose ciphertexts have never been identified, and many ciphertexts whose keys are unknown. This tool helps connect the two. For a **known key**, it trains a small neural network on synthetic examples. That network then reads authentic ciphertexts written with the key, and fails visibly on ciphertexts written with other keys.
+
+The method and its evaluation are described in: *[citation to be added]* <!-- PLACEHOLDER -->
+
+## Three ways to use it
+
+| | What it does | Where it runs |
+|-|--------------|---------------|
+| **① Train a model for your key** | You provide a key and plaintext in the cipher's language; you get a trained model and, optionally, a draft decipherment of your transcription. | [Open in Colab](https://colab.research.google.com/github/mbruton0426/keybridge/blob/main/notebooks/1_train_your_own_model.ipynb) · [Guide](docs/TRAINING_GUIDE.md) |
+| **② Read or scan a ciphertext** | Runs your transcription through one model, or all models in the shared collection. Ranks which keys it fits and which language the result reads like. | [Open in Colab](https://colab.research.google.com/github/mbruton0426/keybridge/blob/main/notebooks/2_read_or_scan_a_ciphertext.ipynb) · [Guide](docs/READING_AND_SCANNING_GUIDE.md) |
+| **Local version** | The same as ① and ② from the command line, entirely on your own computer. It can run fully offline. | [Install and use](docs/LOCAL_INSTALL.md) |
+
+The Colab notebooks need only a Google account and a web browser. Nothing has to be installed, and no code has to be written. Keys and transcriptions are simple text files in one standard format (symbols separated by spaces): see **[Key file format](docs/KEY_FORMAT.md)** and **[Transcription format](docs/TRANSCRIPTION_FORMAT.md)**.
+
+For research use, `keybridge evaluate` scores a model's reading of an authentic ciphertext against its key (F1 with confidence intervals), as reported in the paper; see [LOCAL_INSTALL.md](docs/LOCAL_INSTALL.md#score-a-reading-against-the-key-research).
+
+## What it can and cannot do
+
+**It can**
+- produce **draft decipherments** of transcribed ciphertexts written with a known key;
+- help judge **whether a ciphertext was written with a given key**: text in the key comes out readable, text in another key comes out as nonsense;
+- **rank** the keys in a collection by how well a ciphertext fits them, and say which language each output reads most like.
+
+**It cannot**
+- find an **unknown** key. A key, or at least the full table of which symbol means what, must already be known;
+- replace expert review. All outputs are drafts, and the ranking scores have not yet been validated on real collections.
+
+**Cipher features that are not supported**
+
+The tool handles simple and homophonic substitution, where each cipher symbol stands for exactly one thing (a simple substitution cipher is the special case with one symbol per letter): a letter, a group of letters, a whole word (nomenclature), a word gap, a null, or a "repeat the previous letter" sign. The following are **not** supported:
+
+- **Codes written without separators.** A transcription such as `067547700454`, meaning the codes 0675 4770 0454, cannot be split correctly. Transcribe with spaces between codes.
+- **Symbols with several meanings (polyphones).** Each symbol can stand for only one thing.
+- **Context-dependent rules.** Symbols whose meaning depends on their position or on neighbouring symbols.
+- **Cancellation signs.** Symbols that mean "ignore the previous symbol" or "delete the next symbol".
+- **Other cipher types.** Polyalphabetic ciphers (where the key changes during the text), transposition, and codebooks that need more than a symbol-for-unit table.
+
+Python users can imitate some of these with custom edits (see the guides).
+
+## Privacy
+
+In Colab, files are processed on Google's servers for the length of a session, and are deleted when it ends unless you save them to Google Drive. Nothing is shared unless you choose to share a trained model. For full control, use the [local version](docs/LOCAL_INSTALL.md).
+
+## Repository contents
+
+| Folder | Contents |
+|--------|----------|
+| `notebooks/` | The two Colab notebooks (generated by `tools/build_notebooks.py`). |
+| `src/keybridge/` | The Python package used by the notebooks and the command line. |
+| `docs/` | Guides for users, and [setup notes for maintainers](docs/MAINTAINER_SETUP.md). |
+| `examples/` | Example keys (Maximilian II, Copiale) and a synthetic transcription. |
+| `tools/` | Scripts for building the notebooks and the language statistics. |
+| `hf_collection_template/` | Template for the Hugging Face model collection. |
+| `LICENSE`, `LICENSE-CC-BY-4.0.txt`, `CITATION.cff` | Licences and citation information. |
+
+## Licence and citation
+
+- **Code** (`src/`, `tools/`, `notebooks/`): [MIT licence](LICENSE).
+- **Models, keys, language profiles and documentation:** [CC BY 4.0](LICENSE-CC-BY-4.0.txt).
+
+You may use and adapt all of it for any purpose. If you use the tool, its models or its keys in your work, please cite the publication above. GitHub's "Cite this repository" button gives the reference ([CITATION.cff](CITATION.cff)). When you use a model from the shared collection, please also credit the original source of its key, given in the model's description.

keybridge-1.0.0/README.md

@@ -0,0 +1,63 @@
+# keybridge: neural decipherment of historical simple and homophonic substitution ciphers
+
+Archives hold many cipher keys whose ciphertexts have never been identified, and many ciphertexts whose keys are unknown. This tool helps connect the two. For a **known key**, it trains a small neural network on synthetic examples. That network then reads authentic ciphertexts written with the key, and fails visibly on ciphertexts written with other keys.
+
+The method and its evaluation are described in: *[citation to be added]* <!-- PLACEHOLDER -->
+
+## Three ways to use it
+
+| | What it does | Where it runs |
+|-|--------------|---------------|
+| **① Train a model for your key** | You provide a key and plaintext in the cipher's language; you get a trained model and, optionally, a draft decipherment of your transcription. | [Open in Colab](https://colab.research.google.com/github/mbruton0426/keybridge/blob/main/notebooks/1_train_your_own_model.ipynb) · [Guide](docs/TRAINING_GUIDE.md) |
+| **② Read or scan a ciphertext** | Runs your transcription through one model, or all models in the shared collection. Ranks which keys it fits and which language the result reads like. | [Open in Colab](https://colab.research.google.com/github/mbruton0426/keybridge/blob/main/notebooks/2_read_or_scan_a_ciphertext.ipynb) · [Guide](docs/READING_AND_SCANNING_GUIDE.md) |
+| **Local version** | The same as ① and ② from the command line, entirely on your own computer. It can run fully offline. | [Install and use](docs/LOCAL_INSTALL.md) |
+
+The Colab notebooks need only a Google account and a web browser. Nothing has to be installed, and no code has to be written. Keys and transcriptions are simple text files in one standard format (symbols separated by spaces): see **[Key file format](docs/KEY_FORMAT.md)** and **[Transcription format](docs/TRANSCRIPTION_FORMAT.md)**.
+
+For research use, `keybridge evaluate` scores a model's reading of an authentic ciphertext against its key (F1 with confidence intervals), as reported in the paper; see [LOCAL_INSTALL.md](docs/LOCAL_INSTALL.md#score-a-reading-against-the-key-research).
+
+## What it can and cannot do
+
+**It can**
+- produce **draft decipherments** of transcribed ciphertexts written with a known key;
+- help judge **whether a ciphertext was written with a given key**: text in the key comes out readable, text in another key comes out as nonsense;
+- **rank** the keys in a collection by how well a ciphertext fits them, and say which language each output reads most like.
+
+**It cannot**
+- find an **unknown** key. A key, or at least the full table of which symbol means what, must already be known;
+- replace expert review. All outputs are drafts, and the ranking scores have not yet been validated on real collections.
+
+**Cipher features that are not supported**
+
+The tool handles simple and homophonic substitution, where each cipher symbol stands for exactly one thing (a simple substitution cipher is the special case with one symbol per letter): a letter, a group of letters, a whole word (nomenclature), a word gap, a null, or a "repeat the previous letter" sign. The following are **not** supported:
+
+- **Codes written without separators.** A transcription such as `067547700454`, meaning the codes 0675 4770 0454, cannot be split correctly. Transcribe with spaces between codes.
+- **Symbols with several meanings (polyphones).** Each symbol can stand for only one thing.
+- **Context-dependent rules.** Symbols whose meaning depends on their position or on neighbouring symbols.
+- **Cancellation signs.** Symbols that mean "ignore the previous symbol" or "delete the next symbol".
+- **Other cipher types.** Polyalphabetic ciphers (where the key changes during the text), transposition, and codebooks that need more than a symbol-for-unit table.
+
+Python users can imitate some of these with custom edits (see the guides).
+
+## Privacy
+
+In Colab, files are processed on Google's servers for the length of a session, and are deleted when it ends unless you save them to Google Drive. Nothing is shared unless you choose to share a trained model. For full control, use the [local version](docs/LOCAL_INSTALL.md).
+
+## Repository contents
+
+| Folder | Contents |
+|--------|----------|
+| `notebooks/` | The two Colab notebooks (generated by `tools/build_notebooks.py`). |
+| `src/keybridge/` | The Python package used by the notebooks and the command line. |
+| `docs/` | Guides for users, and [setup notes for maintainers](docs/MAINTAINER_SETUP.md). |
+| `examples/` | Example keys (Maximilian II, Copiale) and a synthetic transcription. |
+| `tools/` | Scripts for building the notebooks and the language statistics. |
+| `hf_collection_template/` | Template for the Hugging Face model collection. |
+| `LICENSE`, `LICENSE-CC-BY-4.0.txt`, `CITATION.cff` | Licences and citation information. |
+
+## Licence and citation
+
+- **Code** (`src/`, `tools/`, `notebooks/`): [MIT licence](LICENSE).
+- **Models, keys, language profiles and documentation:** [CC BY 4.0](LICENSE-CC-BY-4.0.txt).
+
+You may use and adapt all of it for any purpose. If you use the tool, its models or its keys in your work, please cite the publication above. GitHub's "Cite this repository" button gives the reference ([CITATION.cff](CITATION.cff)). When you use a model from the shared collection, please also credit the original source of its key, given in the model's description.

keybridge-1.0.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "keybridge"
+version = "1.0.0"
+description = "Shared-space neural decipherment of historical simple and homophonic substitution ciphers"
+readme = "README.md"
+license = {text = "MIT"}  # code; models, keys, language profiles and docs: CC BY 4.0
+authors = [{name = "Micaella Bruton"}, {name = "Meriem Beloucif"}, {name = "Beáta Megyesi"}]
+requires-python = ">=3.9"
+dependencies = [
+    "torch>=2.1",
+    "scikit-learn>=1.0",
+    "huggingface_hub>=0.20",
+    "datasets>=2.14",
+    "optuna>=3.0",
+]
+
+[project.optional-dependencies]
+search = []  # kept so older install commands still work; optuna is now always installed
+
+[project.scripts]
+keybridge = "keybridge.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/mbruton0426/keybridge"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+keybridge = ["language_profiles/*.json.gz"]

keybridge-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

keybridge-1.0.0/src/keybridge/__init__.py

@@ -0,0 +1,6 @@
+"""Shared-space decipherment of simple and homophonic substitution ciphers.
+
+Train a model for a known key, read transcriptions with it, and test transcriptions
+against a collection of models. See the README for the notebooks and the command line.
+"""
+__version__ = "1.0.0"

keybridge-1.0.0/src/keybridge/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+main()