Update README.md

README.md

@@ -1,12 +1,21 @@
 ---
 library_name: transformers
 pipeline_tag: text2text-generation
+license: mit
+datasets:
+- neovalle/H4rmony
+language:
+- en
+tags:
+- Environment
+- climate
+- ecology
+- ecolinguistics
 ---
-# Model Card for Model ID
+# Model Card for Model neovalle/H4rmoniousCaramel
 
-<!-- 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).
+![image/jpeg](https://cdn-uploads.huggingface.co/production/uploads/64aac16fd4a402e8dce11ebe/LHbRjycepGnho08hxSqZJ.jpeg)
 
 ## Model Details
 
@@ -18,8 +27,8 @@ to better align the model with ecological values through the use of ecolinguisti
 - **Developed by:** Jorge Vallego 
 - **Funded by :** Neovalle Ltd.
 - **Shared by :** airesearch@neovalle.co.uk
-- **Model type:** t5
-- **Language(s) (NLP):** English
+- **Model type:** t5 Language Model
+- **Language(s) (NLP):** Primarily English
 - **License:** MIT
 - **Finetuned from model:** google/flan-t5-large
 
@@ -34,153 +43,28 @@ For testing purposes to gain insight in order to the continous improvement of th
 
 ### Downstream Use
 
-Not recommended as this model is under testing for a specific task only.
+Its direct use in applications is not recommended as this model is under testing for a specific task only
 
 ### Out-of-Scope Use
 
-
+Not meant to be used other than testing and evaluation of the H4rmony dataset.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[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.
+This model might produce biased completions already existing in the base model and unintentionally introduced during fine-tuning.
 
 ## How to Get Started with the Model
 
-Use the code below to get started with the model.
-
-[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]
-
-### 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]
-
-[More Information Needed]
-
-
-#### 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 -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
+It can be loaded and run in a free Colab instance.
 
-### Results
+Code to load base and finetuned models to compare outputs:
 
-[More Information Needed]
+https://github.com/Neovalle/H4rmony/blob/main/H4rmoniousCaramel.ipynb
 
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[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).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## 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:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## 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 [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
+## Training Details
 
-[More Information Needed]
+Supervised Fine Tuning 
 
+### Training Data
 
+H4rmony Dataset - https://huggingface.co/datasets/neovalle/H4rmony