Update README.md

README.md

@@ -5,6 +5,29 @@ colorFrom: yellow
 colorTo: yellow
 sdk: static
 pinned: false
+license: apache-2.0
 ---
 
-Edit this `README.md` markdown file to author your organization card.
+Hierarchy Transformers (HiTs) are capable of interpreting and encoding hierarchies explicitly. 
+
+The relevant code in [HierarchyTransformers](https://github.com/KRR-Oxford/HierarchyTransformers) extends from [Sentence-Transformers](https://huggingface.co/sentence-transformers).
+
+Example usage:
+
+```python
+from hierarchy_transformers import HierarchyTransformer
+from hierarchy_transformers.utils import get_torch_device
+
+# set up the device (use cpu if no gpu found)
+gpu_id = 0
+device = get_torch_device(gpu_id)
+
+# load the model
+model = HierarchyTransformer.load_pretrained('Hierarchy-Transformers/HiT-MiniLM-L12-WordNet')
+
+# entity names to be encoded.
+entity_names = ["computer", "personal computer", "laptop"]
+
+# get the entity embeddings
+entity_embeddings = model.encode(entity_names)
+```