supanthadey1 commited on
Commit
44fcada
·
verified ·
1 Parent(s): 0569e97

Document AFFINose WURCS input contract

Browse files
Files changed (2) hide show
  1. README.md +3 -1
  2. SHA256SUMS +1 -1
README.md CHANGED
@@ -49,6 +49,8 @@ No Hugging Face token is required for this AFFINose checkpoint now that the repo
49
 
50
  Provide one protein-glycan pair or a CSV batch. Glycans should be WURCS strings. Proteins can be provided as IDs linked to precomputed embeddings, or through the companion notebook as raw sequences that are embedded with ESM-C 300M.
51
 
 
 
52
  ## Protein Embedding Requirement
53
 
54
  AFFINose expects per-residue ESM-C 300M embeddings with shape `[L, 960]`. Do not mean-pool the protein before passing it into AFFINose.
@@ -77,7 +79,7 @@ A scalar protein-glycan interaction score from the trained AFFINose head.
77
 
78
  ## Scope
79
 
80
- This repository does not perform IUPAC-condensed to WURCS conversion. For now, provide WURCS directly.
81
 
82
  License metadata is currently `other`; update it when the final release license and citation text are chosen.
83
 
 
49
 
50
  Provide one protein-glycan pair or a CSV batch. Glycans should be WURCS strings. Proteins can be provided as IDs linked to precomputed embeddings, or through the companion notebook as raw sequences that are embedded with ESM-C 300M.
51
 
52
+ Batch CSVs use `sample_id,protein_id,protein_sequence,glycan_wurcs`. Free-text glycan names, common names, SNFG drawings, and IUPAC-condensed strings are not parsed directly by AFFINose. Convert those inputs to WURCS first, then score the protein-glycan pair.
53
+
54
  ## Protein Embedding Requirement
55
 
56
  AFFINose expects per-residue ESM-C 300M embeddings with shape `[L, 960]`. Do not mean-pool the protein before passing it into AFFINose.
 
79
 
80
  ## Scope
81
 
82
+ This repository does not perform IUPAC-condensed/name-to-WURCS conversion. For now, provide WURCS directly.
83
 
84
  License metadata is currently `other`; update it when the final release license and citation text are chosen.
85
 
SHA256SUMS CHANGED
@@ -1,5 +1,5 @@
1
  622368f62c23e97e9137c277eaadcc93ee3901cbb420b591422bb1c2e19689a5 ./.gitattributes
2
- 4c6c8e647573b6950fa6b9350651c9e1ec4c5a9fcba19c10870a28014cfad668 ./README.md
3
  533fe4f9317782e39ad7980caa0f47ad92f1be999dd9489425a9429e2e7c15cb ./checkpoints/affinose_interaction_model.pt
4
  b8621448bb34d81b66e2b0050f3663375841d8f333d3973892ece32e7cc31880 ./config.json
5
  1be88f15fd905882c711f7ceb59b619a93f9cee2c6c7c031f8dbabd35b29e9e0 ./requirements.txt
 
1
  622368f62c23e97e9137c277eaadcc93ee3901cbb420b591422bb1c2e19689a5 ./.gitattributes
2
+ 14980381141b2596b48d0f2e2a33c37e1922eada7428e91da25d57aa2337f78a ./README.md
3
  533fe4f9317782e39ad7980caa0f47ad92f1be999dd9489425a9429e2e7c15cb ./checkpoints/affinose_interaction_model.pt
4
  b8621448bb34d81b66e2b0050f3663375841d8f333d3973892ece32e7cc31880 ./config.json
5
  1be88f15fd905882c711f7ceb59b619a93f9cee2c6c7c031f8dbabd35b29e9e0 ./requirements.txt