supanthadey1 commited on
Commit
5f33f64
·
verified ·
1 Parent(s): 55db074

Document BERTose IAR ambiguity input contract

Browse files
Files changed (2) hide show
  1. README.md +4 -2
  2. SHA256SUMS +1 -1
README.md CHANGED
@@ -44,7 +44,9 @@ No Hugging Face token is required for this BERTose IAR checkpoint now that the r
44
 
45
  ## Input
46
 
47
- Provide one WURCS glycan string or a CSV batch with a WURCS column. The resolver is intended for glycans that already contain uncertainty markers in WURCS form.
 
 
48
 
49
  ## Output
50
 
@@ -52,6 +54,6 @@ Token-level ambiguity-resolution predictions with confidence scores. The compani
52
 
53
  ## Scope
54
 
55
- 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.
56
 
57
  License metadata is currently `other`; update it when the final release license and citation text are chosen.
 
44
 
45
  ## Input
46
 
47
+ Provide one WURCS glycan string or a CSV batch with `sample_id,wurcs`. The resolver is intended for glycans that already contain uncertainty markers in WURCS form.
48
+
49
+ Free-text ambiguous glycan names are not parsed directly. Convert the name or IUPAC-condensed notation to WURCS first. If the structure is ambiguous, preserve that ambiguity in the WURCS string with WURCS-style uncertainty markers before running BERTose IAR.
50
 
51
  ## Output
52
 
 
54
 
55
  ## Scope
56
 
57
+ 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/name-to-WURCS conversion.
58
 
59
  License metadata is currently `other`; update it when the final release license and citation text are chosen.
SHA256SUMS CHANGED
@@ -1,5 +1,5 @@
1
  622368f62c23e97e9137c277eaadcc93ee3901cbb420b591422bb1c2e19689a5 ./.gitattributes
2
- 67775250024ca8da24e0556d70279e9c6dae01f2f6ccc0fbf22b18b788ea360d ./README.md
3
  ae468f4e8c06dc0c3848138a474dc43249aa6d14dfd0df8f58d68fcaad371152 ./checkpoints/bertose_iar_resolver.pt
4
  5b52e098ec662b84900c0c4570404379f8abb15d07c1cea7fe512c036a670131 ./config.json
5
  6a56e6f73b8f874470ecde6e538f3f5029ae23aa6c10559817d1c2a8b59b7c0f ./requirements.txt
 
1
  622368f62c23e97e9137c277eaadcc93ee3901cbb420b591422bb1c2e19689a5 ./.gitattributes
2
+ 649ab9aa7bf2625c7832c25c4002710a22396f466d54966b7643c5445b8bb392 ./README.md
3
  ae468f4e8c06dc0c3848138a474dc43249aa6d14dfd0df8f58d68fcaad371152 ./checkpoints/bertose_iar_resolver.pt
4
  5b52e098ec662b84900c0c4570404379f8abb15d07c1cea7fe512c036a670131 ./config.json
5
  6a56e6f73b8f874470ecde6e538f3f5029ae23aa6c10559817d1c2a8b59b7c0f ./requirements.txt