Added readme

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+pytorch_model.bin filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,18 @@
 ---
 license: mit
 ---
+
+Load each model using:
+
+```python
+from transformers import AutoTokenizer, AutoModelForMaskedLM
+
+tokenizer = AutoTokenizer.from_pretrained("gagneurlab/SpeciesLM", revision = "<<choose model type>>")
+model = AutoModelForMaskedLM.from_pretrained("gagneurlab/SpeciesLM", revision = "<<choose model type>>")
+```
+
+Model type:  
+- Species LM, 3' region: `downstream_species_lm`  
+- Agnostic LM, 3' region: `downstream_agnostic_lm`  
+- Species LM, 5' region: `upstream_species_lm`  
+- Agnostic LM, 5' region: `upstream_agnostic_lm`