Document public BERTose IAR usage

README.md

@@ -14,6 +14,25 @@ tags:
 
 This repository contains the contrastively refined BERTose checkpoint used for iterative ambiguity resolution (IAR) over ambiguous WURCS BPE tokens.
 
+## Quick Start
+
+The recommended user path is the companion notebook:
+
+```python
+from huggingface_hub import hf_hub_download
+
+checkpoint = hf_hub_download(
+    repo_id="supanthadey1/bertose-iar-resolver",
+    filename="checkpoints/bertose_iar_resolver.pt",
+)
+ambiguity_map = hf_hub_download(
+    repo_id="supanthadey1/bertose-iar-resolver",
+    filename="vocab/bpe_ambiguity_tokens.json",
+)
+```
+
+No Hugging Face token is required for this BERTose IAR checkpoint now that the repository is public.
+
 ## Files
 
 - `checkpoints/bertose_iar_resolver.pt` - BERTose IAR checkpoint.
@@ -35,4 +54,4 @@ Token-level ambiguity-resolution predictions with confidence scores. The compani
 
 The resolver provides model-backed token updates and confidence values for ambiguous positions. It does not claim to reconstruct a final canonical WURCS string by itself, and it does not perform IUPAC-condensed to WURCS conversion.
 
-The final license and citation text should be set before public release.
+License metadata is currently `other`; update it when the final release license and citation text are chosen.

SHA256SUMS

@@ -1,5 +1,5 @@
 622368f62c23e97e9137c277eaadcc93ee3901cbb420b591422bb1c2e19689a5  ./.gitattributes
-fad4ffd0536521ec579cd4a510c418a4d1a06a91a4f38a19bec54a7c9f4d1767  ./README.md
+67775250024ca8da24e0556d70279e9c6dae01f2f6ccc0fbf22b18b788ea360d  ./README.md
 ae468f4e8c06dc0c3848138a474dc43249aa6d14dfd0df8f58d68fcaad371152  ./checkpoints/bertose_iar_resolver.pt
 5b52e098ec662b84900c0c4570404379f8abb15d07c1cea7fe512c036a670131  ./config.json
 6a56e6f73b8f874470ecde6e538f3f5029ae23aa6c10559817d1c2a8b59b7c0f  ./requirements.txt