lawhy commited on
Commit
cbd3cb8
·
verified ·
1 Parent(s): 6a6cac8

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -4
README.md CHANGED
@@ -12,7 +12,7 @@ language:
12
  - en
13
  ---
14
 
15
- # Hierarchy-Transformers/HiT-MiniLM-WordNetNoun
16
 
17
  A **Hi**erarchy **T**ransformer Encoder (HiT) model that explicitly encodes entities according to their hierarchical relationships.
18
 
@@ -20,7 +20,7 @@ A **Hi**erarchy **T**ransformer Encoder (HiT) model that explicitly encodes enti
20
 
21
  <!-- Provide a longer summary of what this model is. -->
22
 
23
- HiT-MiniLM-WordNet is a HiT model trained on WordNet's noun hierarchy with random negative sampling.
24
 
25
  - **Developed by:** [Yuan He](https://www.yuanhe.wiki/), Zhangdie Yuan, Jiaoyan Chen, and Ian Horrocks
26
  - **Model type:** Hierarchy Transformer Encoder (HiT)
@@ -37,13 +37,15 @@ HiT-MiniLM-WordNet is a HiT model trained on WordNet's noun hierarchy with rando
37
  - **Repository:** https://github.com/KRR-Oxford/HierarchyTransformers
38
  - **Paper:** [Language Models as Hierarchy Encoders](tbd)
39
 
40
- ## Uses
41
 
42
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
43
 
44
  HiT models are used to encode entities (presented as texts) and predict their hierarhical relationships in hyperbolic space.
45
 
46
- ## Usage
 
 
47
 
48
  Use the code below to get started with the model.
49
 
@@ -65,6 +67,8 @@ entity_names = ["computer", "personal computer", "fruit", "berry"]
65
  entity_embeddings = model.encode(entity_names)
66
  ```
67
 
 
 
68
  Use the entity embeddings to predict the subsumption relationships between them.
69
 
70
  ```python
 
12
  - en
13
  ---
14
 
15
+ # Hierarchy-Transformers/HiT-MiniLM-L12-WordNetNoun
16
 
17
  A **Hi**erarchy **T**ransformer Encoder (HiT) model that explicitly encodes entities according to their hierarchical relationships.
18
 
 
20
 
21
  <!-- Provide a longer summary of what this model is. -->
22
 
23
+ HiT-MiniLM-L12-WordNet is a HiT model trained on WordNet's noun hierarchy with random negative sampling.
24
 
25
  - **Developed by:** [Yuan He](https://www.yuanhe.wiki/), Zhangdie Yuan, Jiaoyan Chen, and Ian Horrocks
26
  - **Model type:** Hierarchy Transformer Encoder (HiT)
 
37
  - **Repository:** https://github.com/KRR-Oxford/HierarchyTransformers
38
  - **Paper:** [Language Models as Hierarchy Encoders](tbd)
39
 
40
+ ## Usage
41
 
42
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
43
 
44
  HiT models are used to encode entities (presented as texts) and predict their hierarhical relationships in hyperbolic space.
45
 
46
+ ### Get Started
47
+
48
+ Install `hierarchy_transformers` (check our [repository](https://github.com/KRR-Oxford/HierarchyTransformers)) through `pip` or `GitHub`.
49
 
50
  Use the code below to get started with the model.
51
 
 
67
  entity_embeddings = model.encode(entity_names)
68
  ```
69
 
70
+ ### Default Probing for Subsumption Prediction
71
+
72
  Use the entity embeddings to predict the subsumption relationships between them.
73
 
74
  ```python