Upload README.md with huggingface_hub

README.md

@@ -24,6 +24,29 @@ get_started_code: "``` python \n    # Use a pipeline as a high-level helper\n
   \        model = AutoModelForSequenceClassification.from_pretrained(\"MattStammers/test-trainer\"\
   )\n                        "
 training_data: 'see Glue dataset: https://huggingface.co/datasets/glue'
+preprocessing: sentence pairs to analyse similarity
+training_regime: user_defined
+speeds_sizes_times: not_relevant
+testing_data: 'MRCP. Link: https://huggingface.co/datasets/SetFit/mrpc'
+testing_factors: unknown
+testing_metrics: unknown
+results: see evaluation results.
+results_summary: results are not bad
+model_examination: model should be interpreted with user discretion.
+model_specs: bert fine-tuned
+compute_infrastructure: requires less than 4GB of GPU to run quickly
+hardware: T600
+hours_used: '0.1'
+cloud_provider: on-prem
+cloud_region: europe
+co2_emitted: very little
+software: python, pytorch with transformers
+citation_bibtex: nil_presently
+citation_apa: not_relevant
+glossary: nil presently
+more_information: can be made available on request
+model_card_authors: Matt Stammers
+model_card_contact: Matt Stammers
 model-index:
 - name: test_trainer
   results:
@@ -132,18 +155,18 @@ see Glue dataset: https://huggingface.co/datasets/glue
 
 #### Preprocessing [optional]
 
-[More Information Needed]
+sentence pairs to analyse similarity
 
 
 #### 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:** user_defined <!--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]
+not_relevant
 
 ## Evaluation
 
@@ -155,33 +178,33 @@ see Glue dataset: https://huggingface.co/datasets/glue
 
 <!-- This should link to a Data Card if possible. -->
 
-[More Information Needed]
+MRCP. Link: https://huggingface.co/datasets/SetFit/mrpc
 
 #### Factors
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+unknown
 
 #### Metrics
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+unknown
 
 ### Results
 
-[More Information Needed]
+see evaluation results.
 
 #### Summary
 
-
+results are not bad
 
 ## Model Examination [optional]
 
 <!-- Relevant interpretability work for the model goes here -->
 
-[More Information Needed]
+model should be interpreted with user discretion.
 
 ## Environmental Impact
 
@@ -189,29 +212,29 @@ see Glue dataset: https://huggingface.co/datasets/glue
 
 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]
+- **Hardware Type:** T600
+- **Hours used:** 0.1
+- **Cloud Provider:** on-prem
+- **Compute Region:** europe
+- **Carbon Emitted:** very little
 
 ## Technical Specifications [optional]
 
 ### Model Architecture and Objective
 
-[More Information Needed]
+bert fine-tuned
 
 ### Compute Infrastructure
 
-[More Information Needed]
+requires less than 4GB of GPU to run quickly
 
 #### Hardware
 
-[More Information Needed]
+T600
 
 #### Software
 
-[More Information Needed]
+python, pytorch with transformers
 
 ## Citation [optional]
 
@@ -219,28 +242,28 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 **BibTeX:**
 
-[More Information Needed]
+nil_presently
 
 **APA:**
 
-[More Information Needed]
+not_relevant
 
 ## Glossary [optional]
 
 <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
-[More Information Needed]
+nil presently
 
 ## More Information [optional]
 
-[More Information Needed]
+can be made available on request
 
 ## Model Card Authors [optional]
 
-[More Information Needed]
+Matt Stammers
 
 ## Model Card Contact
 
-[More Information Needed]
+Matt Stammers