Update README.md

README.md

@@ -4,7 +4,7 @@ language:
 base_model:
 - google-bert/bert-base-uncased
 ---
-# Model Card for Model ID
+<!-- # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
 
@@ -18,75 +18,84 @@ This modelcard aims to be a base template for new models. It has been generated
 
 
 
-- **Developed by:** [More Information Needed]
+<!-- - **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]
+- **License:** [More Information Needed] -->
+- **Finetuned from model :** google-bert/bert-base-uncased
 
-### Model Sources [optional]
+<!-- ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
 - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed] -->
 
 ## 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
 
-### 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
 
 <!-- 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 section is meant to convey both technical and sociotechnical limitations. -->
+This model is trained on controlled dataset.
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 ### 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.
+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.
 
-[More Information Needed]
+1. Download model.
+2. Run testing script.
+
+<!-- [More Information Needed] -->
 
 ## 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. -->
-
-[More Information Needed]
+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
 
-#### Preprocessing [optional]
+<!-- #### Preprocessing [optional]
 
 [More Information Needed]
 
@@ -95,41 +104,43 @@ Use the code below to get started with the model.
 
 - **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]
-
-## Evaluation
+<!-- [More Information Needed] -->
 
+<!-- ## 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]
-
-#### Metrics
+<!-- [More Information Needed] -->
+ -->
+<!-- #### Metrics -->
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 ### Results
 
-[More Information Needed]
+<!-- [More Information Needed] -->
+{'accuracy': 0.9166666666666666, 'precision': 0.9333333333333332, 'recall': 0.9166666666666666, 'f1_score': 0.9153439153439153}
+
 
-#### Summary
+<!-- #### Summary
 
 
 
@@ -137,13 +148,13 @@ Use the code below to get started with the model.
 
 <!-- Relevant interpretability work for the model goes here -->
 
-[More Information Needed]
-
-## Environmental Impact
+<!-- [More Information Needed] -->
+ <!-- --> -->
+<!-- ## 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]
 - **Hours used:** [More Information Needed]
@@ -167,15 +178,15 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 #### Software
 
-[More Information Needed]
+[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]
+<!-- [More Information Needed]
 
 **APA:**
 
@@ -185,7 +196,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 <!-- 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]
 
@@ -197,4 +208,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Contact
 
-[More Information Needed]
+[More Information Needed]
+
+ --> -->