amitagh commited on
Commit
0f0314d
1 Parent(s): c314f0c

Added Citation

Browse files
Files changed (1) hide show
  1. README.md +14 -127
README.md CHANGED
@@ -47,42 +47,8 @@ This is the model card of a 🤗 transformers model that has been pushed on the
47
  ## Uses
48
 
49
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
50
 
51
- ### Direct Use
52
-
53
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
54
-
55
- [More Information Needed]
56
-
57
- ### Downstream Use [optional]
58
-
59
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
60
-
61
- [More Information Needed]
62
-
63
- ### Out-of-Scope Use
64
-
65
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
66
-
67
- [More Information Needed]
68
-
69
- ## Bias, Risks, and Limitations
70
-
71
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
72
-
73
- [More Information Needed]
74
-
75
- ### Recommendations
76
-
77
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
78
-
79
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
80
-
81
- ## How to Get Started with the Model
82
-
83
- Use the code below to get started with the model.
84
-
85
- [More Information Needed]
86
 
87
  ## Training Details
88
 
@@ -97,72 +63,8 @@ Use the code below to get started with the model.
97
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
98
  Continually Pretrained with Lora
99
 
100
- #### Preprocessing [optional]
101
-
102
- [More Information Needed]
103
-
104
-
105
- #### Training Hyperparameters
106
-
107
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
108
-
109
- #### Speeds, Sizes, Times [optional]
110
-
111
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
112
-
113
- [More Information Needed]
114
-
115
- ## Evaluation
116
-
117
- <!-- This section describes the evaluation protocols and provides the results. -->
118
-
119
- ### Testing Data, Factors & Metrics
120
-
121
- #### Testing Data
122
-
123
- <!-- This should link to a Dataset Card if possible. -->
124
 
125
- [More Information Needed]
126
 
127
- #### Factors
128
-
129
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
130
-
131
- [More Information Needed]
132
-
133
- #### Metrics
134
-
135
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
136
-
137
- [More Information Needed]
138
-
139
- ### Results
140
-
141
- [More Information Needed]
142
-
143
- #### Summary
144
-
145
-
146
-
147
- ## Model Examination [optional]
148
-
149
- <!-- Relevant interpretability work for the model goes here -->
150
-
151
- [More Information Needed]
152
-
153
- ## Environmental Impact
154
-
155
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
156
-
157
- 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).
158
-
159
- - **Hardware Type:** [More Information Needed]
160
- - **Hours used:** [More Information Needed]
161
- - **Cloud Provider:** [More Information Needed]
162
- - **Compute Region:** [More Information Needed]
163
- - **Carbon Emitted:** [More Information Needed]
164
-
165
- ## Technical Specifications [optional]
166
 
167
  ### Model Architecture and Objective
168
 
@@ -172,40 +74,25 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
172
 
173
  [A100 80 GB]
174
 
175
- #### Hardware
176
 
177
- [More Information Needed]
178
 
179
- #### Software
180
 
181
- [More Information Needed]
182
 
183
  ## Citation [optional]
184
 
185
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
186
-
187
- **BibTeX:**
188
-
189
- [More Information Needed]
190
-
191
- **APA:**
192
-
193
- [More Information Needed]
194
-
195
- ## Glossary [optional]
196
-
197
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
198
-
199
- [More Information Needed]
200
-
201
- ## More Information [optional]
202
-
203
- [More Information Needed]
204
-
205
- ## Model Card Authors [optional]
206
 
207
- [More Information Needed]
 
 
 
 
 
208
 
209
- ## Model Card Contact
 
210
 
211
- [More Information Needed]
 
47
  ## Uses
48
 
49
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
50
+ This is a very preliminary version. Please use with caution. Would suggest to more updates and final models to try out.
51
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
52
 
53
  ## Training Details
54
 
 
63
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
64
  Continually Pretrained with Lora
65
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
66
 
 
67
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
68
 
69
  ### Model Architecture and Objective
70
 
 
74
 
75
  [A100 80 GB]
76
 
77
+ ## Meet the Developers
78
 
79
+ Get to know the creators behind this innovative model and follow their contributions to the field:
80
 
81
+ - [Amit Ghadge](https://www.linkedin.com/in/amit-ghadge-a162a115/)
82
 
 
83
 
84
  ## Citation [optional]
85
 
86
+ If you use this model in your research, please cite:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
87
 
88
+ ```bibtex
89
+ @misc{amitghadge2024ShivneriLLMv01,
90
+ title={Shivneri-LLM: Your Bilingual Marathi and English Text Generation LLM},
91
+ author={Amit Ghadge},
92
+ year={2024},
93
+ eprint={https://medium.com/@amitagh/shivneri-marathi-llm-e823f0a045d8},
94
 
95
+ }
96
+ ```
97
 
98
+ We hope this model serves as a valuable tool in your NLP toolkit and look forward to seeing the advancements it will enable in the understanding and generation of the Marathi language.