Update README.md

README.md

@@ -1,3 +1,201 @@
----
-license: mit
----
+---
+license: mit
+language:
+- aa
+- ab
+base_model:
+- a-base-model
+pipeline_tag: question-answering
+tags:
+- legal
+- art
+datasets:
+- WiebeVandendriessche/dataset-card-example
+metrics:
+- accuracy
+library_name: bertopic
+
+# Optional. Add this if you want to encode your eval results in a structured way.
+# There is a newer, simpler version of this metadata format in ./eval_results.yaml
+model-index:
+- name: WiebeVandendriessche/model-card-example
+  results:
+  - task:
+      type: automatic-speech-recognition       
+    metrics:
+      - type: wer    
+        value: 20.90  
+        name: Test WER   
+        verifyToken: string 
+---
+
+---
+# For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
+# Doc / guide: https://huggingface.co/docs/hub/model-cards
+{{ card_data }}
+---
+
+# Model Card for WiebeVandendriessche/model-card-example
+
+... A Summary ...
+
+## Model Details
+
+### Model Description
+
+... Description ...
+
+- **Developed by:** Wiebe Vandendriessche
+- **Funded by [optional]:** Wiebe Vandendriessche Funder
+- **Shared by [optional]:** Wiebe Vandendriessche Sharer
+- **Model type:** A good one
+- **Language(s) (NLP):** Dutch
+- **License:** MIT
+- **Finetuned from model [optional]:** something something
+
+### Model Sources [optional]
+
+<!-- Provide the basic links for the model. -->
+
+- **Repository:** [https://example.com/]
+- **Paper [optional]:** [https://example.com/]
+- **Demo [optional]:** [https://example.com/]
+
+## Uses
+
+... Use ...
+
+### Direct Use
+
+... Direct Use ...
+
+### Downstream Use [optional]
+
+<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+
+{{ downstream_use | default("[More Information Needed]", true)}}
+
+### Out-of-Scope Use
+
+... Out of Scope Use ...
+
+## Bias, Risks, and Limitations
+
+... Risks ...
+
+### Recommendations
+
+... Recommendations ...
+
+## How to Get Started with the Model
+
+... Get Started ...
+
+## Training Details
+
+### Training Data
+
+... Training data ...
+
+### Training Procedure
+
+... Training Proc ...
+
+#### Preprocessing [optional]
+
+... Preproccessing ...
+
+#### Training Hyperparameters
+
+- **Training regime:** ... hyperparams ...
+
+#### Speeds, Sizes, Times [optional]
+
+... Speed ...
+
+
+## Evaluation
+
+... Eval ...
+
+### Testing Data, Factors & Metrics
+
+#### Testing Data
+
+... Testing data ...
+
+#### Factors
+
+... Factors ...
+
+#### Metrics
+
+... A Metric ...
+
+### Results
+
+... Results ...
+
+#### Summary
+
+... Summary ...
+
+## Model Examination [optional]
+
+... Exam ...
+
+## Environmental Impact
+
+... Env imp ...
+
+- **Hardware Type:** A potato
+- **Hours used:** 1561
+- **Cloud Provider:** Not Google
+- **Compute Region:** Antarctica
+- **Carbon Emitted:** 458654865
+
+## Technical Specifications [optional]
+
+### Model Architecture and Objective
+
+... Architecture ...
+
+### Compute Infrastructure
+
+... Potato center ...
+
+#### Hardware
+
+... Potato ...
+
+#### Software
+
+... Soft ...
+
+## Citation [optional]
+
+... Cit ...
+
+**BibTeX:**
+
+... BibTex ...
+
+**APA:**
+
+... Apa ...
+
+## Glossary [optional]
+
+... Gloss ...
+
+## More Information [optional]
+
+... info ...
+
+## Model Card Authors [optional]
+
+... authors ...
+
+## Model Card Contact
+
+... the contact of the model card ...