alfiannajih commited on
Commit
3b2d035
1 Parent(s): e75d65c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -166
README.md CHANGED
@@ -10,7 +10,9 @@ base_model: NousResearch/Hermes-3-Llama-3.1-8B
10
  # Model Card for Model ID
11
 
12
  <!-- Provide a quick summary of what the model is/does. -->
13
- G-Retriever integrates Graph Neural Networks (GNN), Large Language Model (LLM), and Retrieval-Augmented Generation(RAG) by using Knowledge Graph. This model was developed by Xiaoxin He.
 
 
14
 
15
  ## Model Details
16
 
@@ -19,175 +21,15 @@ G-Retriever integrates Graph Neural Networks (GNN), Large Language Model (LLM),
19
  <!-- Provide a longer summary of what this model is. -->
20
  While the original method utilized Llama 2 family model as the LLM, this repository has experimented it with Llama 3.1 8B.
21
 
22
- ### Model Sources [optional]
23
 
24
  <!-- Provide the basic links for the model. -->
25
 
26
- - **Repository:** [Original repository](https://github.com/XiaoxinHe/G-Retriever)
27
- - **Paper [optional]:** [G-Retriever Paper](https://arxiv.org/abs/2402.07630)
 
28
 
29
  ## Uses
30
 
31
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
32
- This model is designed to be used as a resume reviewer. The approach involves retrieving a subgraph from a knowledge graph built from LinkedIn job postings and feeding it into a GNN. The features extracted from the subgraph are further processed and concatenated with the input embeddings from the query text. These concatenated features are then passed through the self-attention layer of Llama 3.1 8B.
33
-
34
- ### Direct Use
35
-
36
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
37
-
38
- [More Information Needed]
39
-
40
- ### Downstream Use [optional]
41
-
42
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
43
-
44
- [More Information Needed]
45
-
46
- ### Out-of-Scope Use
47
-
48
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
49
-
50
- [More Information Needed]
51
-
52
- ## Bias, Risks, and Limitations
53
-
54
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
55
-
56
- [More Information Needed]
57
-
58
- ### Recommendations
59
-
60
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
61
-
62
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
63
-
64
- ## How to Get Started with the Model
65
-
66
- Use the code below to get started with the model.
67
-
68
- [More Information Needed]
69
-
70
- ## Training Details
71
-
72
- ### Training Data
73
-
74
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
75
-
76
- [More Information Needed]
77
-
78
- ### Training Procedure
79
-
80
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
81
-
82
- #### Preprocessing [optional]
83
-
84
- [More Information Needed]
85
-
86
-
87
- #### Training Hyperparameters
88
-
89
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
90
-
91
- #### Speeds, Sizes, Times [optional]
92
-
93
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
94
-
95
- [More Information Needed]
96
-
97
- ## Evaluation
98
-
99
- <!-- This section describes the evaluation protocols and provides the results. -->
100
-
101
- ### Testing Data, Factors & Metrics
102
-
103
- #### Testing Data
104
-
105
- <!-- This should link to a Dataset Card if possible. -->
106
-
107
- [More Information Needed]
108
-
109
- #### Factors
110
-
111
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Metrics
116
-
117
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
118
-
119
- [More Information Needed]
120
-
121
- ### Results
122
-
123
- [More Information Needed]
124
-
125
- #### Summary
126
-
127
-
128
-
129
- ## Model Examination [optional]
130
-
131
- <!-- Relevant interpretability work for the model goes here -->
132
-
133
- [More Information Needed]
134
-
135
- ## Environmental Impact
136
-
137
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
138
-
139
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
140
-
141
- - **Hardware Type:** [More Information Needed]
142
- - **Hours used:** [More Information Needed]
143
- - **Cloud Provider:** [More Information Needed]
144
- - **Compute Region:** [More Information Needed]
145
- - **Carbon Emitted:** [More Information Needed]
146
-
147
- ## Technical Specifications [optional]
148
-
149
- ### Model Architecture and Objective
150
-
151
- [More Information Needed]
152
-
153
- ### Compute Infrastructure
154
-
155
- [More Information Needed]
156
-
157
- #### Hardware
158
-
159
- [More Information Needed]
160
-
161
- #### Software
162
-
163
- [More Information Needed]
164
-
165
- ## Citation [optional]
166
-
167
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
168
-
169
- **BibTeX:**
170
-
171
- [More Information Needed]
172
-
173
- **APA:**
174
-
175
- [More Information Needed]
176
-
177
- ## Glossary [optional]
178
-
179
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
180
-
181
- [More Information Needed]
182
-
183
- ## More Information [optional]
184
-
185
- [More Information Needed]
186
-
187
- ## Model Card Authors [optional]
188
-
189
- [More Information Needed]
190
-
191
- ## Model Card Contact
192
-
193
- [More Information Needed]
 
10
  # Model Card for Model ID
11
 
12
  <!-- Provide a quick summary of what the model is/does. -->
13
+ This repository is created for submission to Compfest: Artificial Intelligence Competition (AIC) 16.
14
+
15
+ G-Retriever integrates Graph Neural Networks (GNN), Large Language Model (LLM), and Retrieval-Augmented Generation(RAG) by using Knowledge Graph. This model was originaly developed by Xiaoxin He.
16
 
17
  ## Model Details
18
 
 
21
  <!-- Provide a longer summary of what this model is. -->
22
  While the original method utilized Llama 2 family model as the LLM, this repository has experimented it with Llama 3.1 8B.
23
 
24
+ ### Model Sources
25
 
26
  <!-- Provide the basic links for the model. -->
27
 
28
+ - **Repository:** [Repository](https://github.com/alfiannajih/job-recommender)
29
+ - **Training Script:** [G-Retriever Repository](https://github.com/XiaoxinHe/G-Retriever)
30
+ - **Paper:** [G-Retriever Paper](https://arxiv.org/abs/2402.07630)
31
 
32
  ## Uses
33
 
34
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
35
+ This model is designed to be used as a resume reviewer. The approach involves retrieving a subgraph from a knowledge graph built from LinkedIn job postings and feeding it into a GNN. The features extracted from the subgraph are further processed and concatenated with the input embeddings from the query text. These concatenated features are then passed through the self-attention layer of Llama 3.1 8B to generate a resume review.