Haaaaarsh commited on
Commit
5aca7df
·
verified ·
1 Parent(s): efc0a4f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -168
README.md CHANGED
@@ -1,45 +1,30 @@
1
  ---
2
  library_name: transformers
 
3
  tags:
4
- - llama-factory
 
 
 
 
5
  ---
6
 
7
- # Model Card for Model ID
8
-
9
- <!-- Provide a quick summary of what the model is/does. -->
10
-
11
-
12
-
13
- ## Model Details
14
 
15
  ### Model Description
16
 
17
- <!-- Provide a longer summary of what this model is. -->
18
-
19
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
20
 
21
  - **Developed by:** [More Information Needed]
22
- - **Funded by [optional]:** [More Information Needed]
23
- - **Shared by [optional]:** [More Information Needed]
24
- - **Model type:** [More Information Needed]
25
- - **Language(s) (NLP):** [More Information Needed]
26
- - **License:** [More Information Needed]
27
- - **Finetuned from model [optional]:** [More Information Needed]
28
-
29
- ### Model Sources [optional]
30
 
31
- <!-- Provide the basic links for the model. -->
32
-
33
- - **Repository:** [More Information Needed]
34
- - **Paper [optional]:** [More Information Needed]
35
- - **Demo [optional]:** [More Information Needed]
36
-
37
- ## Uses
38
-
39
- ### Use with transformers
40
 
41
  Make sure to update your transformers installation via `pip install --upgrade transformers`.
42
 
 
 
43
  ```python
44
  import torch
45
  from transformers import pipeline
@@ -62,106 +47,22 @@ outputs = pipe(
62
  print(outputs[0]["generated_text"][-1])
63
  ```
64
 
65
- ### Direct Use
66
-
67
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
68
-
69
- [More Information Needed]
70
-
71
- ### Downstream Use [optional]
72
-
73
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
74
-
75
- [More Information Needed]
76
-
77
- ### Out-of-Scope Use
78
-
79
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
80
-
81
- [More Information Needed]
82
-
83
- ## Bias, Risks, and Limitations
84
-
85
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
86
-
87
- [More Information Needed]
88
-
89
- ### Recommendations
90
-
91
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
92
-
93
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
94
-
95
- ## How to Get Started with the Model
96
-
97
- Use the code below to get started with the model.
98
-
99
- [More Information Needed]
100
 
101
  ## Training Details
102
 
103
  ### Training Data
104
 
105
- <!-- 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. -->
106
-
107
- [More Information Needed]
108
-
109
- ### Training Procedure
110
-
111
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
112
-
113
- #### Preprocessing [optional]
114
-
115
- [More Information Needed]
116
-
117
-
118
- #### Training Hyperparameters
119
-
120
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
121
-
122
- #### Speeds, Sizes, Times [optional]
123
-
124
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
125
 
126
- [More Information Needed]
127
 
128
- ## Evaluation
129
 
130
- <!-- This section describes the evaluation protocols and provides the results. -->
 
 
 
131
 
132
- ### Testing Data, Factors & Metrics
133
-
134
- #### Testing Data
135
-
136
- <!-- This should link to a Dataset Card if possible. -->
137
-
138
- [More Information Needed]
139
-
140
- #### Factors
141
-
142
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
143
-
144
- [More Information Needed]
145
-
146
- #### Metrics
147
-
148
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
149
-
150
- [More Information Needed]
151
-
152
- ### Results
153
-
154
- [More Information Needed]
155
-
156
- #### Summary
157
-
158
-
159
-
160
- ## Model Examination [optional]
161
-
162
- <!-- Relevant interpretability work for the model goes here -->
163
-
164
- [More Information Needed]
165
 
166
  ## Environmental Impact
167
 
@@ -170,52 +71,4 @@ Use the code below to get started with the model.
170
  - **Cloud Provider:** Google Cloud Platform
171
  - **Compute Region:** asia-southeast1
172
  - **Carbon Emitted:** Total emissions are estimated to be 0.85 kgCO$_2$eq of which 100 percents were directly offset by the cloud provider.
173
-
174
-
175
- ## Technical Specifications [optional]
176
-
177
- ### Model Architecture and Objective
178
-
179
- [More Information Needed]
180
-
181
- ### Compute Infrastructure
182
-
183
- [More Information Needed]
184
-
185
- #### Hardware
186
-
187
- [More Information Needed]
188
-
189
- #### Software
190
-
191
- [More Information Needed]
192
-
193
- ## Citation [optional]
194
-
195
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
196
-
197
- **BibTeX:**
198
-
199
- [More Information Needed]
200
-
201
- **APA:**
202
-
203
- [More Information Needed]
204
-
205
- ## Glossary [optional]
206
-
207
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
208
-
209
- [More Information Needed]
210
-
211
- ## More Information [optional]
212
-
213
- [More Information Needed]
214
-
215
- ## Model Card Authors [optional]
216
-
217
- [More Information Needed]
218
-
219
- ## Model Card Contact
220
-
221
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
+ pipeline_tag: text-generation
4
  tags:
5
+ - BGPT
6
+ - meta
7
+ - pytorch
8
+ - llama
9
+ - llama-3
10
  ---
11
 
 
 
 
 
 
 
 
12
 
13
  ### Model Description
14
 
15
+ This model is a finetuned version of Llama3.2-3B-Instruct specifically designed for generating multilingual outputs across multiple Indic languages. The model has been trained on a diverse and curated dataset comprising Hindi, Punjabi, Marathi, Malayalam, Oriya, Kannada, Gujarati, Bengali, Urdu, Tamil, and Telugu. It is optimized to handle natural language tasks such as translation, summarization, and conversational generation across these languages effectively.
 
 
16
 
17
  - **Developed by:** [More Information Needed]
18
+ - **Model type:** Finetuned LLaMA (Language Model for Multilingual Text Generation)
19
+ - **Language(s) (NLP):** Hindi, Punjabi, Marathi, Malayalam, Oriya, Kannada, Gujarati, Bengali, Urdu, Tamil, Telugu
20
+ - **Finetuned from model:** Llama3.2-3B-Instruct
 
 
 
 
 
21
 
22
+ ## How to Get Started with the Model
 
 
 
 
 
 
 
 
23
 
24
  Make sure to update your transformers installation via `pip install --upgrade transformers`.
25
 
26
+ Use the code below to get started with the model.
27
+
28
  ```python
29
  import torch
30
  from transformers import pipeline
 
47
  print(outputs[0]["generated_text"][-1])
48
  ```
49
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
 
51
  ## Training Details
52
 
53
  ### Training Data
54
 
55
+ The training dataset included a diverse collection of text sources in:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
 
57
+ - Hindi, Punjabi, Marathi, Malayalam, Oriya, Kannada, Gujarati, Bengali, Urdu, Tamil, and Telugu.
58
 
59
+ ### Training Parameters
60
 
61
+ - **Optimization Technique**: LoRA (Low-Rank Adaptation)
62
+ - **Epochs**: 3.0
63
+ - **Batch Size**: 2.0 (per device train batch size)
64
+ - **Learning Rate**: 5e-05
65
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
66
 
67
  ## Environmental Impact
68
 
 
71
  - **Cloud Provider:** Google Cloud Platform
72
  - **Compute Region:** asia-southeast1
73
  - **Carbon Emitted:** Total emissions are estimated to be 0.85 kgCO$_2$eq of which 100 percents were directly offset by the cloud provider.
74
+