README.md

---
language:
- en
base_model:
- google-bert/bert-base-uncased
---
<!-- # Model Card for Model ID

<!-- Provide a quick summary of what the model is/does. -->

This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).

## Model Details

### Model Description

<!-- Provide a longer summary of what this model is. -->


<!-- - **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 :** google-bert/bert-base-uncased

## 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. -->
This model classifies food recipe or ingredient into three disctinct categories: Vegan, Vegetarian and Non-vegetarian

## Bias, Risks, and Limitations

<!-- This section is meant to convey both technical and sociotechnical limitations. -->
This model is trained on controlled dataset.

<!-- [More Information Needed] -->

### Recommendations

<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
Model should be fine-tuned on huge book corpus and large synthetic dataset.
<!-- 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

<!-- Use the code below to get started with the model. -->

1. Download model.
2. Run testing script.

## Training Details

### 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. -->
1. https://huggingface.co/datasets/rajputnavya/food-classification-mlm-clean
2. https://huggingface.co/datasets/rajputnavya/food-classification-nsp-format
3. https://huggingface.co/datasets/rajputnavya/food-classification-recipe-classification-data/blob/main/fine_tune_format.jsonl
<!-- [More Information Needed] -->

### Training Procedure

<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
1. Training on mlm and nsp dataset combined
2. Fine-tuning on synthetic dataset for recipe classification

### Results

<!-- [More Information Needed] -->
{'accuracy': 0.9166666666666666, 'precision': 0.9333333333333332, 'recall': 0.9166666666666666, 'f1_score': 0.9153439153439153}