Update README.md

README.md

@@ -1,6 +1,16 @@
 ---
 base_model: google/gemma-2-9b-it
 library_name: peft
+license: apache-2.0
+datasets:
+- neo4j/text2cypher-2024v1
+language:
+- en
+pipeline_tag: text2text-generation
+tags:
+- neo4j
+- cypher
+- text2cypher
 ---
 
 # Model Card for Model ID
@@ -13,136 +23,146 @@ library_name: peft
 
 ### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
+This model serves as a demonstration of how fine-tuning foundational models using the Neo4j-Text2Cypher(2024) Dataset ([link](https://huggingface.co/datasets/neo4j/text2cypher-2024v1)) can enhance performance on the Text2Cypher task.\
+Please note, this is part of ongoing research and exploration, aimed at highlighting the dataset's potential rather than a production-ready solution.
 
 
+**Base model:** google/gemma-2-9b-it \
+**Dataset:** neo4j/text2cypher-2024v1
 
-- **Developed by:** [More Information Needed]
+An overview of the finetuned models and benchmarking results are shared at [Link](TODO Link to Blogposts)
+
+<!-- - **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]
+- **Finetuned from model [optional]:** [More Information Needed] -->
 
-### 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]
-
-### Out-of-Scope Use
+<!-- [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. -->
 
-[More Information Needed]
+We need to be cautious about a few risks:
+* In our evaluation setup, the training and test sets come from the same data distribution (sampled from a larger dataset). If the data distribution changes, the results may not follow the same pattern.
+* The datasets used were gathered from publicly available sources. Over time, foundational models may access both the training and test sets, potentially achieving similar or even better results.
+
+Also check the related blogpost:[Link](TODO Link to Blogposts)
 
-### 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]
+ -->
 
+<!-- #### 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]
 - **Hours used:** [More Information Needed]
@@ -164,15 +184,15 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-#### Software
+#### Software 
 
 [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]
 
@@ -180,11 +200,11 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [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]
 
@@ -196,7 +216,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Contact
 
-[More Information Needed]
+[More Information Needed] -->
 ### Framework versions
 
 - PEFT 0.12.0