supanthadey1 commited on
Commit
cae0bb5
·
verified ·
1 Parent(s): 01c1153

Document public BERTose embedding usage

Browse files
Files changed (2) hide show
  1. README.md +20 -1
  2. SHA256SUMS +1 -1
README.md CHANGED
@@ -13,6 +13,25 @@ tags:
13
 
14
  This repository contains the BERTose checkpoint for WURCS glycan embedding inference. It is the release-facing glycan representation model used by the companion notebook.
15
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
  ## Files
17
 
18
  - `checkpoints/bertose_glycan_encoder.pt` - BERTose glycan encoder checkpoint.
@@ -33,4 +52,4 @@ Dense glycan embeddings. The companion notebook defaults to `[CLS]` pooling and
33
 
34
  This repository does not perform IUPAC-condensed to WURCS conversion. For now, provide WURCS directly.
35
 
36
- The final license and citation text should be set before public release.
 
13
 
14
  This repository contains the BERTose checkpoint for WURCS glycan embedding inference. It is the release-facing glycan representation model used by the companion notebook.
15
 
16
+ ## Quick Start
17
+
18
+ The recommended user path is the companion notebook:
19
+
20
+ ```python
21
+ from huggingface_hub import hf_hub_download
22
+
23
+ checkpoint = hf_hub_download(
24
+ repo_id="supanthadey1/bertose-glycan-encoder",
25
+ filename="checkpoints/bertose_glycan_encoder.pt",
26
+ )
27
+ vocab = hf_hub_download(
28
+ repo_id="supanthadey1/bertose-glycan-encoder",
29
+ filename="vocab/bpe_vocabulary.json",
30
+ )
31
+ ```
32
+
33
+ No Hugging Face token is required for this BERTose checkpoint now that the repository is public.
34
+
35
  ## Files
36
 
37
  - `checkpoints/bertose_glycan_encoder.pt` - BERTose glycan encoder checkpoint.
 
52
 
53
  This repository does not perform IUPAC-condensed to WURCS conversion. For now, provide WURCS directly.
54
 
55
+ 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
- a48dc3bc0dbe330ceddf8a9e32be9f699043c17a74956e852fb658c2ef233bc4 ./README.md
3
  9ff260796c28e9f254d87da95592c686874d3954429d926d99afd2a8f9b6c08f ./checkpoints/bertose_glycan_encoder.pt
4
  d5854b5960b949bee17dcae3078ad15641dd24516a6c73835784518d73adf979 ./config.json
5
  6a56e6f73b8f874470ecde6e538f3f5029ae23aa6c10559817d1c2a8b59b7c0f ./requirements.txt
 
1
  622368f62c23e97e9137c277eaadcc93ee3901cbb420b591422bb1c2e19689a5 ./.gitattributes
2
+ d81f5b4dfbbd391dcec904fae940c8ebaa3fcdd780948cc3b95e55d9cebc8204 ./README.md
3
  9ff260796c28e9f254d87da95592c686874d3954429d926d99afd2a8f9b6c08f ./checkpoints/bertose_glycan_encoder.pt
4
  d5854b5960b949bee17dcae3078ad15641dd24516a6c73835784518d73adf979 ./config.json
5
  6a56e6f73b8f874470ecde6e538f3f5029ae23aa6c10559817d1c2a8b59b7c0f ./requirements.txt