kshabana commited on
Commit
fe8b2c6
1 Parent(s): d077715

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -145
README.md CHANGED
@@ -13,190 +13,70 @@ datasets:
13
  - arbml/alpaca_arabic
14
  ---
15
 
16
- # Model Card for Model ID
17
 
18
- <!-- this is a finetune model of llama3.1 that can perform well and we improved the generatal knoledge and and it can speak bunch of languages like arabic and english
19
 
 
20
 
 
21
 
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: kshabana
26
  - **Funded by no one
27
  - **Shared by kshabana
28
  - **Model type: safetensors and gguf
29
  - **Language(s) Arabic and English
30
- - **License:** [Apache]
31
- - **Finetuned from model [llama3.1]
32
 
33
  ### Model Sources []
34
 
35
- meta-llama/Meta-Llama-3.1-8B-Instruct
36
-
37
- - **Repository:**
38
-
39
- ## Uses
40
-
41
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
42
-
43
- ### Direct Use
44
-
45
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
46
-
47
- [More Information Needed]
48
 
49
- ### Downstream Use [optional]
50
 
51
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
52
 
53
- [More Information Needed]
54
 
55
- ### Out-of-Scope Use
56
 
57
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
58
 
59
- [More Information Needed]
60
 
61
  ## Bias, Risks, and Limitations
62
 
63
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
64
 
65
- [More Information Needed]
66
 
67
- ### Recommendations
68
 
69
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
70
 
71
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
72
 
73
- ## How to Get Started with the Model
 
74
 
75
- Use the code below to get started with the model.
76
 
77
- [More Information Needed]
78
 
79
  ## Training Details
80
 
81
- ### Training Data
82
-
83
- <!-- 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. -->
84
-
85
- [More Information Needed]
86
-
87
- ### Training Procedure
88
-
89
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
90
 
91
- #### Preprocessing [optional]
92
-
93
- [More Information Needed]
94
-
95
-
96
- #### Training Hyperparameters
97
-
98
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
99
-
100
- #### Speeds, Sizes, Times [optional]
101
-
102
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
103
-
104
- [More Information Needed]
105
-
106
- ## Evaluation
107
-
108
- <!-- This section describes the evaluation protocols and provides the results. -->
109
-
110
- ### Testing Data, Factors & Metrics
111
-
112
- #### Testing Data
113
-
114
- <!-- This should link to a Dataset Card if possible. -->
115
-
116
- [More Information Needed]
117
-
118
- #### Factors
119
-
120
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
121
 
122
- [More Information Needed]
123
 
124
- #### Metrics
125
 
126
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
 
 
127
 
128
- [More Information Needed]
129
 
130
  ### Results
131
 
132
- [More Information Needed]
133
-
134
- #### Summary
135
-
136
-
137
-
138
- ## Model Examination [optional]
139
-
140
- <!-- Relevant interpretability work for the model goes here -->
141
-
142
- [More Information Needed]
143
-
144
- ## Environmental Impact
145
-
146
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
147
-
148
- 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).
149
-
150
- - **Hardware Type:** [More Information Needed]
151
- - **Hours used:** [More Information Needed]
152
- - **Cloud Provider:** [More Information Needed]
153
- - **Compute Region:** [More Information Needed]
154
- - **Carbon Emitted:** [More Information Needed]
155
-
156
- ## Technical Specifications [optional]
157
-
158
- ### Model Architecture and Objective
159
-
160
- [More Information Needed]
161
-
162
- ### Compute Infrastructure
163
-
164
- [More Information Needed]
165
-
166
- #### Hardware
167
-
168
- [More Information Needed]
169
-
170
- #### Software
171
-
172
- [More Information Needed]
173
-
174
- ## Citation [optional]
175
-
176
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
177
-
178
- **BibTeX:**
179
-
180
- [More Information Needed]
181
-
182
- **APA:**
183
-
184
- [More Information Needed]
185
-
186
- ## Glossary [optional]
187
-
188
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
189
-
190
- [More Information Needed]
191
-
192
- ## More Information [optional]
193
-
194
- [More Information Needed]
195
-
196
- ## Model Card Authors [optional]
197
-
198
- [More Information Needed]
199
-
200
- ## Model Card Contact
201
 
202
- [More Information Needed]
 
13
  - arbml/alpaca_arabic
14
  ---
15
 
16
+ # INTRO
17
 
18
+ we are happy to announce that we are starting our goat model family
19
 
20
+ # Model Card for Model ID
21
 
22
+ this is a finetune model of llama3.1 that can perform well and we improved the generatal knoledge and and it can speak bunch of languages like arabic and english.
23
 
24
 
 
25
 
26
  - **Developed by: kshabana
27
  - **Funded by no one
28
  - **Shared by kshabana
29
  - **Model type: safetensors and gguf
30
  - **Language(s) Arabic and English
31
+ - **License:** Apache2.0
32
+ - **Finetuned from model [llama3.1-instruct]
33
 
34
  ### Model Sources []
35
 
36
+ https://huggingface.co/meta-llama/Meta-Llama-3.1-8B-Instruct
 
 
 
 
 
 
 
 
 
 
 
 
37
 
38
+ - **Dataset Repository:**
39
 
40
+ https://huggingface.co/datasets/arbml/alpaca_arabic
41
 
42
+ ## Uses
43
 
44
+ this model can be used for combanys that need multilagul support and it has a 131072 context lingth.
45
 
 
46
 
 
47
 
48
  ## Bias, Risks, and Limitations
49
 
50
+ it can some times produce a wrong answer.
51
 
 
52
 
 
53
 
54
+ ### Recommendations
55
 
56
+ NOTE:you shold have lm studio or ollama to use this model
57
 
58
+ IN LM-STUDIO:it is recommended to use this model with the defult lm-studio configration.
59
+ IN OLLAMA: we will be pushing the model soon to ollama.
60
 
 
61
 
 
62
 
63
  ## Training Details
64
 
65
+ model trained with unsloth.
 
 
 
 
 
 
 
 
66
 
67
+ ### Training Data
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
68
 
69
+ the training dataset that i used: https://huggingface.co/datasets/arbml/alpaca_arabic
70
 
71
+ ## IMPORTANT LINKS
72
 
73
+ OLLAMA: https://ollama.com
74
+ LM-STUDIO: https://lmstudio.ai
75
+ llama3.1: instruct: https://huggingface.co/meta-llama/Meta-Llama-3.1-8B-Instruct
76
+ dataset: https://huggingface.co/datasets/arbml/alpaca_arabic
77
 
 
78
 
79
  ### Results
80
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
81
 
82
+ ![Screenshot 2024-08-14 141239.png](https://cdn-uploads.huggingface.co/production/uploads/650b3f38b5b6029d37298ae8/N-jYQm1uDwxeaAFZXZsPA.png)