finnbusse commited on
Commit
13ff7ab
·
verified ·
1 Parent(s): bae7ee1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -153
README.md CHANGED
@@ -12,195 +12,56 @@ datasets:
12
 
13
  # Model Card for Model ID
14
 
15
- GrabbeAI ist ein fortschrittliches KI-Modell, das auf der leistungsstarken Google Gemma 2 Architektur basiert. Entwickelt von talentierten Schülern der 10. Klasse des Grabbe Gymnasiums Detmold, wurde GrabbeAI speziell trainiert, um Besuchern der Schulwebsite einfache Informationen über die Schule bereitzustellen und Fragen zum Schulalltag umfassend zu beantworten.
16
-
17
-
18
 
19
  ## Model Details
20
 
21
- ### Model Description
22
 
23
- <!-- Provide a longer summary of what this model is. -->
24
 
25
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
26
 
27
  - **Developed by:** Finn Busse, Evan Charter, Raphael Scheimann, Ilias Vogt, Maximilian von Beck
28
- - **Funded by [optional]:** [More Information Needed]
29
- - **Shared by [optional]:** [More Information Needed]
30
- - **Model type:** [More Information Needed]
31
  - **Language(s) (NLP):** German, English
32
  - **License:** gemma2
33
  - **Finetuned from model [optional]:** gemma2
34
 
35
- ### Model Sources [optional]
36
-
37
- <!-- Provide the basic links for the model. -->
38
-
39
- - **Repository:** [More Information Needed]
40
- - **Paper [optional]:** [More Information Needed]
41
- - **Demo [optional]:** [More Information Needed]
42
-
43
- ## Uses
44
-
45
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
46
-
47
  ### Direct Use
48
 
49
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
50
-
51
- [More Information Needed]
52
-
53
- ### Downstream Use [optional]
54
-
55
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
56
-
57
- [More Information Needed]
58
-
59
- ### Out-of-Scope Use
60
-
61
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
62
-
63
- [More Information Needed]
64
-
65
- ## Bias, Risks, and Limitations
66
-
67
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
68
 
69
- [More Information Needed]
70
-
71
- ### Recommendations
72
-
73
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
74
 
75
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
76
 
77
  ## How to Get Started with the Model
78
 
79
- Use the code below to get started with the model.
80
-
81
- [More Information Needed]
82
-
83
- ## Training Details
84
 
85
  ### Training Data
86
 
87
- <!-- 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. -->
88
-
89
- [More Information Needed]
90
-
91
- ### Training Procedure
92
-
93
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
94
-
95
- #### Preprocessing [optional]
96
-
97
- [More Information Needed]
98
-
99
-
100
- #### Training Hyperparameters
101
-
102
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
103
-
104
- #### Speeds, Sizes, Times [optional]
105
-
106
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
107
-
108
- [More Information Needed]
109
-
110
- ## Evaluation
111
-
112
- <!-- This section describes the evaluation protocols and provides the results. -->
113
-
114
- ### Testing Data, Factors & Metrics
115
 
116
  #### Testing Data
117
 
118
- <!-- This should link to a Dataset Card if possible. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Factors
123
-
124
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
125
-
126
- [More Information Needed]
127
 
128
- #### Metrics
129
-
130
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
131
-
132
- [More Information Needed]
133
 
134
  ### Results
135
 
136
- [More Information Needed]
137
-
138
- #### Summary
139
-
140
-
141
-
142
- ## Model Examination [optional]
143
-
144
- <!-- Relevant interpretability work for the model goes here -->
145
-
146
- [More Information Needed]
147
-
148
- ## Environmental Impact
149
-
150
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
151
-
152
- 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).
153
-
154
- - **Hardware Type:** [More Information Needed]
155
- - **Hours used:** [More Information Needed]
156
- - **Cloud Provider:** [More Information Needed]
157
- - **Compute Region:** [More Information Needed]
158
- - **Carbon Emitted:** [More Information Needed]
159
-
160
- ## Technical Specifications [optional]
161
-
162
- ### Model Architecture and Objective
163
-
164
- [More Information Needed]
165
-
166
- ### Compute Infrastructure
167
-
168
- [More Information Needed]
169
-
170
- #### Hardware
171
-
172
- [More Information Needed]
173
 
174
  #### Software
175
 
176
- [More Information Needed]
177
-
178
- ## Citation [optional]
179
-
180
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
181
-
182
- **BibTeX:**
183
-
184
- [More Information Needed]
185
-
186
- **APA:**
187
-
188
- [More Information Needed]
189
-
190
- ## Glossary [optional]
191
-
192
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
193
-
194
- [More Information Needed]
195
-
196
- ## More Information [optional]
197
-
198
- [More Information Needed]
199
 
200
  ## Model Card Authors [optional]
201
 
202
- [More Information Needed]
203
 
204
  ## Model Card Contact
205
 
206
- [More Information Needed]
 
12
 
13
  # Model Card for Model ID
14
 
15
+ GrabbeAI is an advanced AI model based on the powerful Google Gemma 2 architecture. Developed by talented 10th-grade students from Grabbe Gymnasium Detmold, GrabbeAI is specifically trained to provide visitors of the school's website with straightforward information about the institution and answer a wide range of questions related to daily school life.
 
 
16
 
17
  ## Model Details
18
 
19
+ Students of Grabbe-Gymnasium Detmold, Germany have been writing their own dataset to train Gemma 2 for their schools website with Google Colab.
20
 
21
+ ### Model Description
22
 
23
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
24
 
25
  - **Developed by:** Finn Busse, Evan Charter, Raphael Scheimann, Ilias Vogt, Maximilian von Beck
26
+ - **Shared by [optional]:** Grabbe-Gymnasium Detmold
27
+ - **Model type:** AI chatbot
 
28
  - **Language(s) (NLP):** German, English
29
  - **License:** gemma2
30
  - **Finetuned from model [optional]:** gemma2
31
 
 
 
 
 
 
 
 
 
 
 
 
 
32
  ### Direct Use
33
 
34
+ GrabbeAI is designed to be directly used on the Grabbe-Gymnasium Detmold, Germany website to answer inquiries about school information and daily activities.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
+ ### Riscs
 
 
 
 
37
 
38
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
39
 
40
  ## How to Get Started with the Model
41
 
42
+ Soon: support for Ollama; not working yet
 
 
 
 
43
 
44
  ### Training Data
45
 
46
+ [https://huggingface.co/datasets/grabbe-gymnasium-detmold/grabbeai]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
47
 
48
  #### Testing Data
49
 
50
+ [https://huggingface.co/datasets/grabbe-gymnasium-detmold/grabbeai]
 
 
 
 
 
 
 
 
51
 
 
 
 
 
 
52
 
53
  ### Results
54
 
55
+ GrabbeAI now serves as an AI chatbot tool on the Grabbes website.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
 
57
  #### Software
58
 
59
+ GrabbeAI can be used with Ollama.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
60
 
61
  ## Model Card Authors [optional]
62
 
63
+ ChatGPT
64
 
65
  ## Model Card Contact
66
 
67
+ Grabbe-Gymnasium Detmold, Germany