Upload folder using huggingface_hub

README.md

@@ -1,85 +1,202 @@
 ---
-license: llama2
 library_name: peft
-tags:
-- trl
-- sft
-- generated_from_trainer
 base_model: meta-llama/Llama-2-7b-chat-hf
-datasets:
-- generator
-model-index:
-- name: sexed-llama2-7b-sft-lora-v1
-  results: []
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+# Model Card for Model ID
 
-# sexed-llama2-7b-sft-lora-v1
+<!-- Provide a quick summary of what the model is/does. -->
 
-This model is a fine-tuned version of [meta-llama/Llama-2-7b-chat-hf](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf) on the generator dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.2927
 
-## Model description
 
-More information needed
+## Model Details
 
-## Intended uses & limitations
+### Model Description
 
-More information needed
+<!-- Provide a longer summary of what this model is. -->
 
-## Training and evaluation data
 
-More information needed
 
-## Training procedure
+- **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 hyperparameters
+### Model Sources [optional]
 
-The following hyperparameters were used during training:
-- learning_rate: 1e-05
-- train_batch_size: 2
-- eval_batch_size: 2
-- seed: 42
-- gradient_accumulation_steps: 16
-- total_train_batch_size: 32
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: cosine
-- num_epochs: 20
-- mixed_precision_training: Native AMP
+<!-- Provide the basic links for the model. -->
 
-### Training results
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
 
-| Training Loss | Epoch   | Step | Validation Loss |
-|:-------------:|:-------:|:----:|:---------------:|
-| 0.982         | 0.9905  | 85   | 0.9568          |
-| 0.6293        | 1.9927  | 171  | 0.6171          |
-| 0.572         | 2.9949  | 257  | 0.5583          |
-| 0.5226        | 3.9971  | 343  | 0.5129          |
-| 0.4752        | 4.9993  | 429  | 0.4724          |
-| 0.427         | 5.9898  | 514  | 0.4362          |
-| 0.3741        | 6.9920  | 600  | 0.3605          |
-| 0.3232        | 7.9942  | 686  | 0.3278          |
-| 0.3145        | 8.9964  | 772  | 0.3170          |
-| 0.3083        | 9.9985  | 858  | 0.3100          |
-| 0.2957        | 10.9891 | 943  | 0.3049          |
-| 0.3016        | 11.9913 | 1029 | 0.3011          |
-| 0.3018        | 12.9934 | 1115 | 0.2983          |
-| 0.3071        | 13.9956 | 1201 | 0.2962          |
-| 0.3069        | 14.9978 | 1287 | 0.2948          |
-| 0.2881        | 16.0    | 1373 | 0.2938          |
-| 0.2881        | 16.9905 | 1458 | 0.2932          |
-| 0.2892        | 17.9927 | 1544 | 0.2929          |
-| 0.2884        | 18.9949 | 1630 | 0.2927          |
-| 0.3003        | 19.8106 | 1700 | 0.2927          |
+## 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
+
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+
+[More Information Needed]
+
+### 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
+
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+
+[More Information Needed]
+
+## 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.
+
+## 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]
+
+### Results
+
+[More Information Needed]
+
+#### 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
+
+[More Information Needed]
 ### Framework versions
 
-- PEFT 0.11.1
-- Transformers 4.41.1
-- Pytorch 2.0.1+cu118
-- Datasets 2.19.1
-- Tokenizers 0.19.1
+- PEFT 0.11.1