upload readme

README.md

@@ -1 +1,25 @@
-# Ankh 3 XL
+# Ankh 3 XL
+
+```python
+from transformers import AutoTokenizer, AutoModel, T5EncoderModel, T5Tokenizer
+import torch
+
+tokenizer = T5Tokenizer.from_pretrained("ElnaggarLab/ankh3-xl")
+encoder = T5EncoderModel.from_pretrained("ElnaggarLab/ankh3-xl")
+protenrich = AutoModel.from_pretrained("SaeedLab/ProtEnrich-Ankh3", trust_remote_code=True)
+
+seqs = "MKTFFVLLL"
+seqs = "[NLU]" + seqs
+inputs = tokenizer([seqs], return_tensors="pt", padding=True)
+
+with torch.no_grad():
+  outputs = encoder(**inputs)
+  pooled = outputs.last_hidden_state[0, 1:-1].mean(axis=0)
+  enriched = protenrich(pooled)
+
+print('H enrich:', enriched.h_enrich)
+print('H anchor:', enriched.h_anchor)
+print('H algn:', enriched.h_algn)
+print('Structure:', enriched.struct)
+print('Dynamics:', enriched.dyn)
+```