Upload folder using huggingface_hub

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+image.png filter=lfs diff=lfs merge=lfs -text

README.md

@@ -7,150 +7,174 @@ tags: []
 
 <!-- Provide a quick summary of what the model is/does. -->
 
+## Model Details
+An experimental 145M parameter pre-trained base model for marathi. Inspired by SmolLM2 and its architecture.
 
+Pre-trained on verified marathi split of the [`ai4bharat/sangraha`](https://huggingface.co/datasets/ai4bharat/sangraha) dataset, around ~2.8 billion tokens.
 
-## Model Details
+Note: This is an experimental model and will be followed by more pre-training, followed by task specific instruction finetuning.
+
+## How to use
+```python
+# Load model directly
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+tokenizer = AutoTokenizer.from_pretrained("sky-2002/Marathi-SmolLM2-145M")
+model = AutoModelForCausalLM.from_pretrained("sky-2002/Marathi-SmolLM2-145M")
+
+sentence = "पुणे विद्यापीठाने म्हटले आहे"
+inputs = tokenizer(sentence, return_tensors="pt")
+output = model.generate(**inputs, max_length=50)
+print(tokenizer.batch_decode(output, skip_special_tokens=True))
+```
+
+### Model Description, data and training details
+
+**Architecture**: SmolLM2 based
 
-### Model Description
+**Tokenizer**: Uses the `sarvamai/sarvam-1` tokenizer, since it has been trained on indic languages and has lower fertility rates than existing multilingual tokenizers.
 
+**Training dataset**:
+The training dataset covers the following domains.
+
+![alt text](image.png)
 <!-- Provide a longer summary of what this model is. -->
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+**Training**:
+- Trained using modal platform on an A100.
+- Trained for 1 epoch on verified marathi split of sangraha dataset, covering ~5.8M samples.
+
+This model can generate coherent text, especially in the domains similar to those in the training dataset.
 
-### Model Sources [optional]
+<!-- ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
+<!-- - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed] -->
 
-## Uses
+<!-- ## Uses
 
 <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
-### Direct Use
+<!-- ### Direct Use -->
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Downstream Use [optional]
+<!-- ### Downstream Use [optional] -->
 
 <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Out-of-Scope Use
+<!-- ### Out-of-Scope Use -->
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 ## Bias, Risks, and Limitations
+This model is trained on data of 2.8 B tokens and using a context length of 512, due to computational constraints of training.
+Often gives out gibberish if prompt is not related to domains shown, or if in a conversational style.
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Recommendations
+<!-- ### Recommendations
 
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+<!-- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations. -->
 
-## How to Get Started with the Model
+<!-- ## How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+[More Information Needed] -->
 
-## Training Details
+<!-- ## Training Details
 
-### Training Data
+### Training Data -->
 
 <!-- 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. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-### Training Procedure
+### Training Procedure -->
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-#### Preprocessing [optional]
+<!-- #### Preprocessing [optional]
 
-[More Information Needed]
+[More Information Needed] -->
 
 
-#### Training Hyperparameters
+<!-- #### Training Hyperparameters -->
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+<!-- - **Training regime:** [More Information Needed] fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 
-#### Speeds, Sizes, Times [optional]
+<!-- #### Speeds, Sizes, Times [optional] -->
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Evaluation
+<!-- ## Evaluation -->
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
+<!-- ### Testing Data, Factors & Metrics
 
-#### Testing Data
+#### Testing Data -->
 
 <!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-#### Factors
+#### Factors -->
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-#### Metrics
+#### Metrics -->
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
 ### Results
 
 [More Information Needed]
 
-#### Summary
+#### Summary -->
 
 
 
-## Model Examination [optional]
+<!-- ## Model Examination [optional] -->
 
 <!-- Relevant interpretability work for the model goes here -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-## Environmental Impact
+## Environmental Impact -->
 
 <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
 
-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).
+<!-- 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).
 
-- **Hardware Type:** [More Information Needed]
+- **Hardware Type:** A100
 - **Hours used:** [More Information Needed]
 - **Cloud Provider:** [More Information Needed]
 - **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
+- **Carbon Emitted:** [More Information Needed] -->
 
-## Technical Specifications [optional]
+<!-- ## Technical Specifications [optional]
 
 ### Model Architecture and Objective
 
@@ -168,32 +192,32 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-## Citation [optional]
+## Citation [optional] -->
 
 <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
-**BibTeX:**
+<!-- **BibTeX:**
 
 [More Information Needed]
 
 **APA:**
 
-[More Information Needed]
+[More Information Needed] -->
 
-## Glossary [optional]
+<!-- ## Glossary [optional] -->
 
 <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-## More Information [optional]
+## More Information [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-## Model Card Authors [optional]
+## Model Card Authors [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
 ## Model Card Contact
 
-[More Information Needed]
+[More Information Needed] -->

tokenizer.model

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4cd33409a577e8b416247587b0f5bd7a3eec245a1f18d4ec7793ff299ad3fbe2
+size 1935856